Skip to content

Commit 6467fea

Browse files
authored
Update index.rst
1 parent 3fa5a85 commit 6467fea

File tree

1 file changed

+21
-16
lines changed

1 file changed

+21
-16
lines changed

docs/source/index.rst

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -34,27 +34,18 @@ Please support the development of CEBRA by starring and/or watching the project
3434
Installation and Setup
3535
----------------------
3636

37-
Please see the dedicated :doc:`Installation Guide </installation>` for information on installation options using ``conda``, ``pip`` and ``docker``.
38-
39-
Have fun! 😁
37+
Please see the dedicated :doc:`Installation Guide </installation>` for information on installation options using ``conda``, ``pip`` and ``docker``. Have fun! 😁
4038

4139
Usage
4240
-----
4341

4442
Please head over to the :doc:`Usage </usage>` tab to find step-by-step instructions to use CEBRA on your data. For example use cases, see the :doc:`Demos </demos>` tab.
4543

46-
Integrations
47-
------------
48-
49-
CEBRA can be directly integrated with existing libraries commonly used in data analysis. The ``cebra.integrations`` module
50-
is getting actively extended. Right now, we offer integrations for ``scikit-learn``-like usage of CEBRA, a package making use of ``matplotlib`` to plot the CEBRA model results, as well as the
51-
possibility to compute CEBRA embeddings on DeepLabCut_ outputs directly.
52-
5344

5445
Licensing
5546
---------
56-
57-
Since version 0.4.0, CEBRA is open source software under an Apache 2.0 license.
47+
The ideas presented in our package are currently patent pending (Patent No. WO2023143843).
48+
Since version 0.4.0, CEBRA's source is licenced under an Apache 2.0 license.
5849
Prior versions 0.1.0 to 0.3.1 were released for academic use only.
5950

6051
Please see the full license file on Github_ for further information.
@@ -65,12 +56,18 @@ Contributing
6556

6657
Please refer to the :doc:`Contributing </contributing>` tab to find our guidelines on contributions.
6758

68-
Code contributors
59+
Code Contributors
6960
-----------------
7061

71-
The CEBRA code was originally developed by Steffen Schneider, Jin H. Lee, and Mackenzie Mathis (up to internal version 0.0.2). As of March 2023, it is being actively extended and maintained by `Steffen Schneider`_, `Célia Benquet`_, and `Mackenzie Mathis`_.
62+
The CEBRA code was originally developed by Steffen Schneider, Jin H. Lee, and Mackenzie Mathis (up to internal version 0.0.2). Please see our AUTHORS file for more information.
7263

73-
References
64+
Integrations
65+
------------
66+
67+
CEBRA can be directly integrated with existing libraries commonly used in data analysis. Namely, we provide a ``scikit-learn`` style interface to use CEBRA. Additionally, we offer integrations with our ``scikit-learn``-style of using CEBRA, a package making use of ``matplotlib`` and ``plotly`` to plot the CEBRA model results, as well as the possibility to compute CEBRA embeddings on DeepLabCut_ outputs directly. If you have another suggestion, please head over to Discussions_ on GitHub_!
68+
69+
70+
Key References
7471
----------
7572
.. code::
7673
@@ -82,14 +79,22 @@ References
8279
year = {2023},
8380
}
8481
82+
@article{xCEBRA2025,
83+
author={Steffen Schneider and Rodrigo Gonz{\'a}lez Laiz and Anastasiia Filippova and Markus Frey and Mackenzie W Mathis},
84+
title = {Time-series attribution maps with regularized contrastive learning},
85+
journal = {AISTATS},
86+
url = {https://openreview.net/forum?id=aGrCXoTB4P},
87+
year = {2025},
88+
}
89+
8590
This documentation is based on the `PyData Theme`_.
8691

8792

8893
.. _`Twitter`: https://twitter.com/cebraAI
8994
.. _`PyData Theme`: https://github.com/pydata/pydata-sphinx-theme
9095
.. _`DeepLabCut`: https://deeplabcut.org
96+
.. _`Discissions`: https://github.com/AdaptiveMotorControlLab/CEBRA/discussions
9197
.. _`Github`: https://github.com/AdaptiveMotorControlLab/cebra
9298
.. _`email`: mailto:[email protected]
9399
.. _`Steffen Schneider`: https://github.com/stes
94-
.. _`Célia Benquet`: https://github.com/CeliaBenquet
95100
.. _`Mackenzie Mathis`: https://github.com/MMathisLab

0 commit comments

Comments
 (0)