You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/index.rst
+21-16Lines changed: 21 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,27 +34,18 @@ Please support the development of CEBRA by starring and/or watching the project
34
34
Installation and Setup
35
35
----------------------
36
36
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! 😁
40
38
41
39
Usage
42
40
-----
43
41
44
42
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.
45
43
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
-
53
44
54
45
Licensing
55
46
---------
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.
58
49
Prior versions 0.1.0 to 0.3.1 were released for academic use only.
59
50
60
51
Please see the full license file on Github_ for further information.
@@ -65,12 +56,18 @@ Contributing
65
56
66
57
Please refer to the :doc:`Contributing </contributing>` tab to find our guidelines on contributions.
67
58
68
-
Code contributors
59
+
Code Contributors
69
60
-----------------
70
61
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.
72
63
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
74
71
----------
75
72
.. code::
76
73
@@ -82,14 +79,22 @@ References
82
79
year = {2023},
83
80
}
84
81
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},
0 commit comments