Update Agent Docs
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 8
- Forks
- 4
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 4
Description
Agent docs in docs/agents/ptgp-vfe/ are out of date in light of recent changes. They need to be updated. Here is a partial list of things I found, but an exhaustive check needs to be conducted:
-
reference/api.md:58: training.py:728 → :898 -
reference/workflow.md:120: training.py:728 → :898 -
pitfalls/sigma_collapse.md:66: training.py:728 → :898 -
reference/api.md:87: Points(Z) missing Z_init arg -
reference/api.md:32: sig missing compile_kwargs -
reference/discrete_inputs.md:93: kmeans_init is :377 not :101
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the files under docs/agents/ptgp-vfe/, especially reference/api.md, reference/workflow.md, pitfalls/sigma_collapse.md, and reference/discrete_inputs.md. Compare their training.py line references and signatures with the current code, including the listed Points, sig, and kmeans_init discrepancies. Done means the documented APIs, line references, and examples are consistent with the current implementation after an exhaustive check.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100