initial version

Author: yoavf

.github/workflows/deploy.yml

@@ -0,0 +1,53 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './dist'
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,32 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+# Environment variables
+.env
+.env.local
+.env.*.local
+
+# OS files
+Thumbs.db

CONTRIBUTING.md

@@ -0,0 +1,80 @@
+# Contributing to metrics.help
+
+Thank you for your interest in contributing to metrics.help!
+
+## How to Contribute
+
+### Adding or Improving Metrics
+
+Create or edit a markdown file in `src/content/metrics/` using this structure:
+
+```markdown
+---
+id: metric-id
+name: Display Name
+aliases: [metric_id, alternative_name, another_alias]
+shortDescription: Brief one-line description of the metric.
+whatToLookFor:
+  - Key point to watch for
+  - Another important indicator
+  - Warning signs
+visualizations:
+  yDomain: [min, max]  # e.g., [0, 1] or [0, 100]
+  healthy:
+    data:
+      - { step: 0, value: 0.5 }
+      - { step: 10, value: 0.7 }
+      # Add more data points showing healthy progression
+  unhealthy:
+    data:
+      - { step: 0, value: 0.5 }
+      - { step: 10, value: 0.3 }
+      # Add more data points showing problematic patterns
+---
+
+# Detailed Explanation
+
+Provide a clear, beginner-friendly explanation of what this metric measures and why it matters.
+
+## Common Issues
+
+Describe common problems or patterns to watch out for.
+
+## Related Metrics
+
+Link to related metrics that practitioners should also monitor.
+```
+
+### Adding or Improving Algorithms
+
+Create or edit a markdown file in `src/content/algorithms/` following a similar structure, explaining:
+- What the algorithm does
+- Key metrics to watch when using this algorithm
+- Common issues and solutions
+- Links to papers or resources
+
+### Fixing Errors or Improving Clarity
+
+- Fix typos or unclear explanations
+- Add examples or better visualizations
+- Improve accuracy of technical content
+
+## Content Guidelines
+
+When adding or editing content:
+
+- **Be beginner-friendly**: Assume readers are learning
+- **Be practical**: Focus on actionable insights
+- **Be concise**: Get to the point quickly
+- **Use examples**: Show real patterns, not just theory
+- **Test visualizations**: Ensure data points create clear, understandable graphs
+
+## Submitting Changes
+
+1. Fork the repository
+2. Make your changes
+3. Submit a pull request with a clear description of what you've added or fixed
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the MIT License (code) and CC0 (content).

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 metrics.help
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,23 @@
+# metrics.help
+
+Simple, visual explanations for machine learning metrics and algorithms.
+
+## What is this?
+
+metrics.help is an educational resource that helps you understand the metrics and algorithms you see during machine learning training, with a focus on LLM fine-tuning and reinforcement learning.
+
+**Features:**
+- Visual explanations showing what healthy vs. unhealthy metric patterns look like
+- Clear interpretations of what to look for in your training runs
+- Algorithm explanations for common training techniques (DPO, GRPO, KTO, etc.)
+- Log analyzer to paste your training logs and get instant insights
+
+## Contributing
+
+Found an error? Have a suggestion? Want to add a new metric or algorithm?
+
+Contributions are welcome! Please feel free to submit a Pull Request with corrections, additions, or improvements. See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on adding new content.
+
+## License
+
+Code: [MIT](LICENSE) | Content: [CC0](https://creativecommons.org/publicdomain/zero/1.0/)