docs: sync documentation with post-v0.2 changes
This commit is contained in:
+19
-10
@@ -15,6 +15,7 @@ pip install -e ".[dev]"
|
||||
### 🐛 Bug Reports
|
||||
|
||||
Open an issue with:
|
||||
|
||||
- Steps to reproduce
|
||||
- Expected vs actual behavior
|
||||
- Config file used (sanitize API keys)
|
||||
@@ -25,21 +26,29 @@ Open an issue with:
|
||||
See [Add a New Benchmark](guide/new-benchmark.md) for the implementation guide.
|
||||
|
||||
**Checklist:**
|
||||
- [ ] Data loader in `skillopt/envs/<benchmark>/loader.py`
|
||||
- [ ] Environment adapter in `skillopt/envs/<benchmark>/env.py`
|
||||
|
||||
- [ ] Data loader in `skillopt/envs/<benchmark>/dataloader.py`
|
||||
- [ ] Scored rollout implementation in `skillopt/envs/<benchmark>/rollout.py`
|
||||
- [ ] Per-item `predictions/<id>/conversation.json` artifacts for shared reflection
|
||||
- [ ] Environment adapter in `skillopt/envs/<benchmark>/adapter.py`
|
||||
- [ ] Config file in `configs/<benchmark>/default.yaml`
|
||||
- [ ] Registration in `skillopt/envs/__init__.py`
|
||||
- [ ] Documentation page in `docs/`
|
||||
- [ ] Lazy registration in `scripts/train.py` and `scripts/eval_only.py`
|
||||
- [ ] Focused tests and an optional seed skill referenced by `env.skill_init`
|
||||
- [ ] Documentation update
|
||||
|
||||
### 🤖 New Model Backend
|
||||
|
||||
See [Add a New Model Backend](guide/new-backend.md) for the implementation guide.
|
||||
|
||||
**Checklist:**
|
||||
- [ ] Backend in `skillopt/model/<backend>.py`
|
||||
- [ ] Registration in `skillopt/model/__init__.py`
|
||||
- [ ] API key entry in `.env.example`
|
||||
- [ ] Documentation update
|
||||
|
||||
- [ ] Function-based backend module in `skillopt/model/<name>_backend.py`
|
||||
- [ ] Alias and default model in `skillopt/model/common.py`
|
||||
- [ ] Optimizer/target whitelist entries in `skillopt/model/backend_config.py`
|
||||
- [ ] Dispatch, token tracking, and setter forwarding in `skillopt/model/__init__.py`
|
||||
- [ ] YAML/CLI wiring when the backend exposes structured config fields
|
||||
- [ ] Focused routing, configuration, tool-call, and token-accounting tests
|
||||
- [ ] `.env.example` and backend/configuration reference updates
|
||||
|
||||
### 📝 Documentation
|
||||
|
||||
@@ -59,9 +68,9 @@ mkdocs serve # Preview at http://localhost:8000
|
||||
## Pull Request Process
|
||||
|
||||
1. Fork the repository
|
||||
2. Create a feature branch: `git checkout -b feature/my-benchmark`
|
||||
2. Create a feature branch: `git switch -c feature/my-benchmark`
|
||||
3. Make your changes
|
||||
4. Test with an existing benchmark config
|
||||
4. Run focused tests, the full test suite, and `mkdocs build --strict` when docs change
|
||||
5. Submit a PR with a clear description
|
||||
|
||||
## License
|
||||
|
||||
Reference in New Issue
Block a user