First pass for the user documentation #91
Conversation
|
Here is a pre-built version of the code in this pull request: wheels.zip, you can install it locally by unzipping |
|
The documentation for this pull request is (or will soon be) available on readthedocs: https://equistore--91.org.readthedocs.build/en/91/ |
This adds a skeleton of the documentation, and uses sphinx-gallery to render tutorials online. Co-authored-by: Jigyasa Nigam <[email protected]> Co-authored-by: HowWeiBin <[email protected]> Co-authored-by: Philip Loche <[email protected]>
|
I removed the figures from the git history, to prevent polluting it too much until we converge to the final version. Here are the files for reference.
|
| Equivariant Linear Model | ||
| ------------------------ | ||
|
|
||
| TBD |
There was a problem hiding this comment.
Since I am currently doing a Ridge implementation in equisolve, I am asking myself if an example really belongs here or do we just link to equisolve on this page?
There was a problem hiding this comment.
My idea was more to provide a simple example using equistore.operations directly. Then the doc should 100% link to equisolve as a more complete implementation of this!
|
As agreed today with @curiosity54 and @HowWeiBin today we should try to keep this branch going. The user base is increasing and we need proper tutorials to clearly state what equistore can do and where to find things. One example is that it may seems that equistore objects are immutable since python like operations (i.e. from equistore import Tensormap
import equistore.operations as eqst
tensor = Tensormap(xxx)
tensor = eqst. add(tensor, 5) |
There was a problem hiding this comment.
I talked to @Luthaf yesterday about the the user documentation and we think it is already in a really good shape!
I like the tutorials. But, they require a bit more explanation of what is going on between the code cells. Also, please split the one big tutorial into a second at the point where you start training an actual model.
| # %% | ||
| # | ||
| # Training your first model using Equistore | ||
| # ----------------------------------------- | ||
| # |
There was a problem hiding this comment.
I suggest we split the Training your first model using Equistore into a second tutorial.
|
There have been a lot of improvement on the documentation, but this PR still contains some other tutorials that should be integrated. Keeping this open for now, until we have to time to finish the tutorial work. |
This is contains the same changes as #69, squashed into a single commit.
Here is a list of remaining things to do:
get-started/equistore)We also have to add how-to & friends, but It would be better of as separate PR to ensure we can merge this one quickly!