Skip to content

Commit

Permalink
Fix docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
stes committed Oct 20, 2024
1 parent 6a38d8e commit 2f564f6
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 4 deletions.
4 changes: 2 additions & 2 deletions cebra/integrations/matplotlib.py
Original file line number Diff line number Diff line change
Expand Up @@ -290,13 +290,13 @@ def _define_plot_dim(
* If ``idx_order`` is not provided, the plot will be 3D by default.
* If ``idx_order`` is provided, if it has 3 dimensions, the plot will be 3D, if only 2 dimensions
are provided, the plot will be 2D.
are provided, the plot will be 2D.
If the embedding dimension is equal to 2:
* If ``idx_order`` is not provided, the plot will be 2D by default.
* If ``idx_order`` is provided, if it has 3 dimensions, the plot will be 3D, if 2 dimensions
are provided, the plot will be 2D.
are provided, the plot will be 2D.
This is supposing that the dimensions provided to ``idx_order`` are in the range of the number of
dimensions of the embedding (i.e., between 0 and :py:attr:`cebra.CEBRA.output_dimension` -1).
Expand Down
3 changes: 1 addition & 2 deletions cebra/integrations/sklearn/cebra.py
Original file line number Diff line number Diff line change
Expand Up @@ -1337,13 +1337,12 @@ def save(self,
- 'state': The state of the CEBRA model, which includes various internal attributes.
- 'state_dict': The state dictionary of the underlying solver used by CEBRA.
- 'metadata': Additional metadata about the saved model, including the backend used and
the version of CEBRA PyTorch, NumPy and scikit-learn.
the version of CEBRA PyTorch, NumPy and scikit-learn.
"torch" backend:
The model is directly saved using `torch.save` with no additional information. The saved
file contains the entire CEBRA model state.
Example:
>>> import cebra
Expand Down

0 comments on commit 2f564f6

Please sign in to comment.