-
Notifications
You must be signed in to change notification settings - Fork 23
Open
Labels
DocumentationImprovements or additions to documentationImprovements or additions to documentation
Description
Location of the issue
https://docs.metatensor.org/metatrain/latest/dev-docs/index.html
Description of the issue
We are making the tools and workflows for devs better and better 🎉. We are adding a testsuite (#920), the new rendering of the hypers (#863) or using the metatensor nn.Module (#938). However, I think the docs for devs are still very chaotic and unstructured.
Suggested fix or improvement (optional)
- We should add a general subsection for the Python API
- Move the CHANGELOG somewhere else. This is not really only relevant for devs but evenly or even more relevant for users.
- We could a subsection Developer concepts similar to the user concepts. There goes the Life Cycle of an Architecture, Adding a new architecture, DatasetInformation, new loss function
The new section structure could be
Contrbuting
Python API
Developer Concepts
each with the subsections mentioned above.
The DatasetInformation page also needs some proofreading. Maybe this can also be done with the new rendering in Python (@pfebrer)
Additional context
No response
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
DocumentationImprovements or additions to documentationImprovements or additions to documentation