Add AGENTS.md, CLAUDE.md#1480
Conversation
There was a problem hiding this comment.
how was this file created?
/init?
as a result of discussing with Claude?
There was a problem hiding this comment.
/init, and then thorough discussion based on the last merged PR. I then rewrote any bits that are just wrong or too verbose (to my knowledge)
The caveat with /init only is that it's very surface level with lots of useless information that is easily accessible, my goal is for these files to provide the right entry point so no context/time is lost
There was a problem hiding this comment.
what's the purpose of the redirect? are there other agends that would read AGENTS.md directly? Codex?
There was a problem hiding this comment.
Basically all the other AI providers use the AGENTS.md but Anthropic/Claude - so yes the best practice seems to just redirect on CLAUDE.md
There was a problem hiding this comment.
Isn't a symlink better here? That's what I've seen in other projects.
|
|
||
| ## Recipes | ||
|
|
||
| ### Add a new model family |
There was a problem hiding this comment.
I don't think we should have these recipes.
- adding a new model: I have created an experimental PLAN_NEWMODEL.md, learned while implementing Anima and Lens. It alone is 15 kb text. This short recipe won't work well.
- add a new LR scheduler: we rarely if ever do that
- add a noise scheduler: we never do that; modern models have their fixed noise scheduler
- the optimizer recipe might be the only useful one here.
There was a problem hiding this comment.
Sounds good I'll change that. I guess it might make sense to commit the PLAN_NEWMODEL.md in docs/ and just pointing to there wdyt? That way, it should be easy to iterate/suggest improvement to this directly so knowledge isn't lost across sessions
i'll do this with the Optimizer recipe
There was a problem hiding this comment.
Done as well, Optimizer recipe extracted to docs/recipes/AddOptimizer.md pointed to from AGENTS.md
|
Should be ready now |
| @@ -0,0 +1,33 @@ | |||
| <!-- | |||
| Thanks for contributing to OneTrainer. | |||
| Please read AGENTS.md (project rules for any AI-assisted work) before opening this PR, | |||
There was a problem hiding this comment.
people read their CLAUDE.md? is this really good advice?
There was a problem hiding this comment.
People definitely should read the CLAUDE/AGENTS.md and contribute to it in order to make it live and not stale honestly. Granted it's read by the AI agents but it outlines general context of the repo and it's not anything not useful to any human from my pov
agree on the PR template (only one comment above) |
This comment was marked as resolved.
This comment was marked as resolved.
TheForgotten69
changed the title
3 participants
Summary
Adds contributor tooling for AI-assisted development and a standard PR template.
codebase layout, factory/auto-discovery architecture, step-by-step recipes for common
extension points (new model family, optimizer, LR scheduler, config field), and a
footguns section covering known sharp edges (LayerOffloadConductor, ZLUDA, CTK workaround, etc.).
Test plan
pre-commit run --all-filespassesAI assistance