Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Document the custom model config files #247

Open
clefourrier opened this issue Jul 31, 2024 · 2 comments · May be fixed by #465
Open

[DOC] Document the custom model config files #247

clefourrier opened this issue Jul 31, 2024 · 2 comments · May be fixed by #465

Comments

@clefourrier
Copy link
Member

No description provided.

@ParagEkbote
Copy link
Contributor

ParagEkbote commented Dec 15, 2024

Could you please point to the files/ folder you'd like to document? I'd love to open a PR to fix this.

cc: @clefourrier

@clefourrier
Copy link
Member Author

I don't think we have a lot of documentation on our model creation files (the yaml files you can use to load models) (though it's been improved since the creation of this issue) - you should look for the ModelConfig example files (here) and all the Config classes at the top of each model file in this folder.
It would make sense to open 2 PRs: one to update the docstrings of all config files, and one to add a "Create a model" guide page in the doc :)

@ParagEkbote ParagEkbote linked a pull request Dec 19, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants