Skip to content

Commit a004c8a

Browse files
authored
Merge branch 'main' into add_options_mixed
2 parents aeef065 + 31460de commit a004c8a

File tree

103 files changed

+1797
-541
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

103 files changed

+1797
-541
lines changed

.github/workflows/build.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ jobs:
2626
- os: windows-latest
2727
torch-version: 2.0.0
2828
python-version: "3.10"
29+
- os: ubuntu-latest
30+
torch-version: 2.1.1
31+
python-version: "3.11"
2932
#- os: macos-latest
3033
# torch-version: 2.0.0
3134
# python-version: "3.10"

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ RUN make dist
4242
FROM cebra-base
4343

4444
# install the cebra wheel
45-
ENV WHEEL=cebra-0.3.1rc1-py2.py3-none-any.whl
45+
ENV WHEEL=cebra-0.4.0-py2.py3-none-any.whl
4646
WORKDIR /build
4747
COPY --from=wheel /build/dist/${WHEEL} .
4848
RUN pip install --no-cache-dir ${WHEEL}'[dev,integrations,datasets]'

LICENSE.md

Lines changed: 198 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,201 @@
1+
# CEBRA License
2+
3+
## Versioning Notice
4+
5+
- Versions < 0.1.0 have "no license", see https://choosealicense.com/no-permission/.
6+
- Versions 0.1.0 to 0.3.1 are covered under the Non-Commercial License Agreement appended below.
7+
- Versions 0.4.0 - present are covered under the Apache-2.0 license appended below.
8+
9+
Please note EPFL has filed a patent titled "Dimensionality reduction of time-series data, and
10+
systems and devices that use the resultant embeddings" (https://patents.google.com/patent/WO2023143843A1)
11+
so if this does not work for your non-academic use case, please contact the TTO Office at EPFL.
12+
13+
## Version 0.4.0+ are covered under the following license
14+
15+
Copyright (2023-present) Mackenzie W. Mathis & Steffen Schneider
16+
17+
**Apache License**
18+
19+
Version 2.0, January 2004
20+
21+
http://www.apache.org/licenses/
22+
23+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
24+
25+
1. Definitions.
26+
27+
"License" shall mean the terms and conditions for use, reproduction,
28+
and distribution as defined by Sections 1 through 9 of this document.
29+
30+
"Licensor" shall mean the copyright owner or entity authorized by
31+
the copyright owner that is granting the License.
32+
33+
"Legal Entity" shall mean the union of the acting entity and all
34+
other entities that control, are controlled by, or are under common
35+
control with that entity. For the purposes of this definition,
36+
"control" means (i) the power, direct or indirect, to cause the
37+
direction or management of such entity, whether by contract or
38+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
39+
outstanding shares, or (iii) beneficial ownership of such entity.
40+
41+
"You" (or "Your") shall mean an individual or Legal Entity
42+
exercising permissions granted by this License.
43+
44+
"Source" form shall mean the preferred form for making modifications,
45+
including but not limited to software source code, documentation
46+
source, and configuration files.
47+
48+
"Object" form shall mean any form resulting from mechanical
49+
transformation or translation of a Source form, including but
50+
not limited to compiled object code, generated documentation,
51+
and conversions to other media types.
52+
53+
"Work" shall mean the work of authorship, whether in Source or
54+
Object form, made available under the License, as indicated by a
55+
copyright notice that is included in or attached to the work
56+
(an example is provided in the Appendix below).
57+
58+
"Derivative Works" shall mean any work, whether in Source or Object
59+
form, that is based on (or derived from) the Work and for which the
60+
editorial revisions, annotations, elaborations, or other modifications
61+
represent, as a whole, an original work of authorship. For the purposes
62+
of this License, Derivative Works shall not include works that remain
63+
separable from, or merely link (or bind by name) to the interfaces of,
64+
the Work and Derivative Works thereof.
65+
66+
"Contribution" shall mean any work of authorship, including
67+
the original version of the Work and any modifications or additions
68+
to that Work or Derivative Works thereof, that is intentionally
69+
submitted to Licensor for inclusion in the Work by the copyright owner
70+
or by an individual or Legal Entity authorized to submit on behalf of
71+
the copyright owner. For the purposes of this definition, "submitted"
72+
means any form of electronic, verbal, or written communication sent
73+
to the Licensor or its representatives, including but not limited to
74+
communication on electronic mailing lists, source code control systems,
75+
and issue tracking systems that are managed by, or on behalf of, the
76+
Licensor for the purpose of discussing and improving the Work, but
77+
excluding communication that is conspicuously marked or otherwise
78+
designated in writing by the copyright owner as "Not a Contribution."
79+
80+
"Contributor" shall mean Licensor and any individual or Legal Entity
81+
on behalf of whom a Contribution has been received by Licensor and
82+
subsequently incorporated within the Work.
83+
84+
2. Grant of Copyright License. Subject to the terms and conditions of
85+
this License, each Contributor hereby grants to You a perpetual,
86+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
87+
copyright license to reproduce, prepare Derivative Works of,
88+
publicly display, publicly perform, sublicense, and distribute the
89+
Work and such Derivative Works in Source or Object form.
90+
91+
3. Grant of Patent License. Subject to the terms and conditions of
92+
this License, each Contributor hereby grants to You a perpetual,
93+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
94+
(except as stated in this section) patent license to make, have made,
95+
use, offer to sell, sell, import, and otherwise transfer the Work,
96+
where such license applies only to those patent claims licensable
97+
by such Contributor that are necessarily infringed by their
98+
Contribution(s) alone or by combination of their Contribution(s)
99+
with the Work to which such Contribution(s) was submitted. If You
100+
institute patent litigation against any entity (including a
101+
cross-claim or counterclaim in a lawsuit) alleging that the Work
102+
or a Contribution incorporated within the Work constitutes direct
103+
or contributory patent infringement, then any patent licenses
104+
granted to You under this License for that Work shall terminate
105+
as of the date such litigation is filed.
106+
107+
4. Redistribution. You may reproduce and distribute copies of the
108+
Work or Derivative Works thereof in any medium, with or without
109+
modifications, and in Source or Object form, provided that You
110+
meet the following conditions:
111+
112+
(a) You must give any other recipients of the Work or
113+
Derivative Works a copy of this License; and
114+
115+
(b) You must cause any modified files to carry prominent notices
116+
stating that You changed the files; and
117+
118+
(c) You must retain, in the Source form of any Derivative Works
119+
that You distribute, all copyright, patent, trademark, and
120+
attribution notices from the Source form of the Work,
121+
excluding those notices that do not pertain to any part of
122+
the Derivative Works; and
123+
124+
(d) If the Work includes a "NOTICE" text file as part of its
125+
distribution, then any Derivative Works that You distribute must
126+
include a readable copy of the attribution notices contained
127+
within such NOTICE file, excluding those notices that do not
128+
pertain to any part of the Derivative Works, in at least one
129+
of the following places: within a NOTICE text file distributed
130+
as part of the Derivative Works; within the Source form or
131+
documentation, if provided along with the Derivative Works; or,
132+
within a display generated by the Derivative Works, if and
133+
wherever such third-party notices normally appear. The contents
134+
of the NOTICE file are for informational purposes only and
135+
do not modify the License. You may add Your own attribution
136+
notices within Derivative Works that You distribute, alongside
137+
or as an addendum to the NOTICE text from the Work, provided
138+
that such additional attribution notices cannot be construed
139+
as modifying the License.
140+
141+
You may add Your own copyright statement to Your modifications and
142+
may provide additional or different license terms and conditions
143+
for use, reproduction, or distribution of Your modifications, or
144+
for any such Derivative Works as a whole, provided Your use,
145+
reproduction, and distribution of the Work otherwise complies with
146+
the conditions stated in this License.
147+
148+
5. Submission of Contributions. Unless You explicitly state otherwise,
149+
any Contribution intentionally submitted for inclusion in the Work
150+
by You to the Licensor shall be under the terms and conditions of
151+
this License, without any additional terms or conditions.
152+
Notwithstanding the above, nothing herein shall supersede or modify
153+
the terms of any separate license agreement you may have executed
154+
with Licensor regarding such Contributions.
155+
156+
6. Trademarks. This License does not grant permission to use the trade
157+
names, trademarks, service marks, or product names of the Licensor,
158+
except as required for reasonable and customary use in describing the
159+
origin of the Work and reproducing the content of the NOTICE file.
160+
161+
7. Disclaimer of Warranty. Unless required by applicable law or
162+
agreed to in writing, Licensor provides the Work (and each
163+
Contributor provides its Contributions) on an "AS IS" BASIS,
164+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
165+
implied, including, without limitation, any warranties or conditions
166+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
167+
PARTICULAR PURPOSE. You are solely responsible for determining the
168+
appropriateness of using or redistributing the Work and assume any
169+
risks associated with Your exercise of permissions under this License.
170+
171+
8. Limitation of Liability. In no event and under no legal theory,
172+
whether in tort (including negligence), contract, or otherwise,
173+
unless required by applicable law (such as deliberate and grossly
174+
negligent acts) or agreed to in writing, shall any Contributor be
175+
liable to You for damages, including any direct, indirect, special,
176+
incidental, or consequential damages of any character arising as a
177+
result of this License or out of the use or inability to use the
178+
Work (including but not limited to damages for loss of goodwill,
179+
work stoppage, computer failure or malfunction, or any and all
180+
other commercial damages or losses), even if such Contributor
181+
has been advised of the possibility of such damages.
182+
183+
9. Accepting Warranty or Additional Liability. While redistributing
184+
the Work or Derivative Works thereof, You may choose to offer,
185+
and charge a fee for, acceptance of support, warranty, indemnity,
186+
or other liability obligations and/or rights consistent with this
187+
License. However, in accepting such obligations, You may act only
188+
on Your own behalf and on Your sole responsibility, not on behalf
189+
of any other Contributor, and only if You agree to indemnify,
190+
defend, and hold each Contributor harmless for any liability
191+
incurred by, or claims asserted against, such Contributor by reason
192+
of your accepting any such warranty or additional liability.
193+
194+
END OF TERMS AND CONDITIONS
195+
196+
197+
## Versions 0.1.0 to 0.3.1 are covered under the following agreement:
198+
1199
**Non-Commercial License Agreement: CEBRA**
2200

3201
© All rights reserved. ECOLE POLYTECHNIQUE FÉDÉRALE DE LAUSANNE, Switzerland,

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
CEBRA_VERSION := 0.3.1rc1
1+
CEBRA_VERSION := 0.4.0
22

33
dist:
44
python3 -m pip install virtualenv

NOTICE.yml

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,25 @@
1010

1111
# Main repository license
1212
- header: |
13-
(c) All rights reserved. ECOLE POLYTECHNIQUE FÉDÉRALE DE LAUSANNE,
14-
Switzerland, Laboratory of Prof. Mackenzie W. Mathis (UPMWMATHIS) and
15-
original authors: Steffen Schneider, Jin H Lee, Mackenzie W Mathis. 2023.
16-
13+
CEBRA: Consistent EmBeddings of high-dimensional Recordings using Auxiliary variables
14+
© Mackenzie W. Mathis & Steffen Schneider (v0.4.0+)
1715
Source code:
1816
https://github.com/AdaptiveMotorControlLab/CEBRA
1917
2018
Please see LICENSE.md for the full license document:
21-
https://github.com/AdaptiveMotorControlLab/CEBRA/LICENSE.md
19+
https://github.com/AdaptiveMotorControlLab/CEBRA/blob/main/LICENSE.md
20+
21+
Licensed under the Apache License, Version 2.0 (the "License");
22+
you may not use this file except in compliance with the License.
23+
You may obtain a copy of the License at
24+
25+
http://www.apache.org/licenses/LICENSE-2.0
26+
27+
Unless required by applicable law or agreed to in writing, software
28+
distributed under the License is distributed on an "AS IS" BASIS,
29+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
30+
See the License for the specific language governing permissions and
31+
limitations under the License.
2232
2333
include:
2434
- 'cebra/**/*.py'

PKGBUILD

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Maintainer: Steffen Schneider <[email protected]>
22
pkgname=python-cebra
33
_pkgname=cebra
4-
pkgver=0.3.1rc1
4+
pkgver=0.4.0
55
pkgrel=1
66
pkgdesc="Consistent Embeddings of high-dimensional Recordings using Auxiliary variables"
77
url="https://cebra.ai"

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
[![Downloads](https://static.pepy.tech/badge/cebra)](https://pepy.tech/project/cebra)
1919
[![Downloads](https://static.pepy.tech/badge/cebra/month)](https://pepy.tech/project/cebra)
2020
[![PyPI version](https://badge.fury.io/py/cebra.svg)](https://badge.fury.io/py/cebra)
21-
![License: Non-Commercial](https://img.shields.io/badge/License-Non--commercial-lightgrey)
21+
![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-red)
2222
[![Twitter Follow](https://img.shields.io/twitter/follow/CEBRAAI.svg?label=CEBRAai&style=social)](https://twitter.com/CEBRAAI)
2323

2424

@@ -47,4 +47,5 @@ It can jointly use behavioral and neural data in a hypothesis- or discovery-driv
4747

4848
# License
4949

50-
- CEBRA is released for academic use only (please read the license file). If this license is not appropriate for your application, please contact Prof. Mackenzie W. Mathis ([email protected]) for a commercial use license.
50+
- Since version 0.4.0, CEBRA is open source software under an Apache 2.0 license.
51+
- Prior versions 0.1.0 to 0.3.1 were released for academic use only (please read the license file).

cebra/__init__.py

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,23 @@
11
#
2-
# (c) All rights reserved. ECOLE POLYTECHNIQUE FÉDÉRALE DE LAUSANNE,
3-
# Switzerland, Laboratory of Prof. Mackenzie W. Mathis (UPMWMATHIS) and
4-
# original authors: Steffen Schneider, Jin H Lee, Mackenzie W Mathis. 2023.
5-
#
2+
# CEBRA: Consistent EmBeddings of high-dimensional Recordings using Auxiliary variables
3+
# © Mackenzie W. Mathis & Steffen Schneider (v0.4.0+)
64
# Source code:
75
# https://github.com/AdaptiveMotorControlLab/CEBRA
86
#
97
# Please see LICENSE.md for the full license document:
10-
# https://github.com/AdaptiveMotorControlLab/CEBRA/LICENSE.md
8+
# https://github.com/AdaptiveMotorControlLab/CEBRA/blob/main/LICENSE.md
9+
#
10+
# Licensed under the Apache License, Version 2.0 (the "License");
11+
# you may not use this file except in compliance with the License.
12+
# You may obtain a copy of the License at
13+
#
14+
# http://www.apache.org/licenses/LICENSE-2.0
15+
#
16+
# Unless required by applicable law or agreed to in writing, software
17+
# distributed under the License is distributed on an "AS IS" BASIS,
18+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19+
# See the License for the specific language governing permissions and
20+
# limitations under the License.
1121
#
1222
"""CEBRA is a library for estimating Consistent Embeddings of high-dimensional Recordings
1323
using Auxiliary variables. It contains self-supervised learning algorithms implemented in
@@ -56,7 +66,7 @@
5666

5767
import cebra.integrations.sklearn as sklearn
5868

59-
__version__ = "0.3.1rc1"
69+
__version__ = "0.4.0"
6070
__all__ = ["CEBRA"]
6171
__allow_lazy_imports = False
6272
__lazy_imports = {}

cebra/__main__.py

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,23 @@
11
#
2-
# (c) All rights reserved. ECOLE POLYTECHNIQUE FÉDÉRALE DE LAUSANNE,
3-
# Switzerland, Laboratory of Prof. Mackenzie W. Mathis (UPMWMATHIS) and
4-
# original authors: Steffen Schneider, Jin H Lee, Mackenzie W Mathis. 2023.
5-
#
2+
# CEBRA: Consistent EmBeddings of high-dimensional Recordings using Auxiliary variables
3+
# © Mackenzie W. Mathis & Steffen Schneider (v0.4.0+)
64
# Source code:
75
# https://github.com/AdaptiveMotorControlLab/CEBRA
86
#
97
# Please see LICENSE.md for the full license document:
10-
# https://github.com/AdaptiveMotorControlLab/CEBRA/LICENSE.md
8+
# https://github.com/AdaptiveMotorControlLab/CEBRA/blob/main/LICENSE.md
9+
#
10+
# Licensed under the Apache License, Version 2.0 (the "License");
11+
# you may not use this file except in compliance with the License.
12+
# You may obtain a copy of the License at
13+
#
14+
# http://www.apache.org/licenses/LICENSE-2.0
15+
#
16+
# Unless required by applicable law or agreed to in writing, software
17+
# distributed under the License is distributed on an "AS IS" BASIS,
18+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19+
# See the License for the specific language governing permissions and
20+
# limitations under the License.
1121
#
1222
"""CEBRA command line interface.
1323

cebra/config.py

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,23 @@
11
#
2-
# (c) All rights reserved. ECOLE POLYTECHNIQUE FÉDÉRALE DE LAUSANNE,
3-
# Switzerland, Laboratory of Prof. Mackenzie W. Mathis (UPMWMATHIS) and
4-
# original authors: Steffen Schneider, Jin H Lee, Mackenzie W Mathis. 2023.
5-
#
2+
# CEBRA: Consistent EmBeddings of high-dimensional Recordings using Auxiliary variables
3+
# © Mackenzie W. Mathis & Steffen Schneider (v0.4.0+)
64
# Source code:
75
# https://github.com/AdaptiveMotorControlLab/CEBRA
86
#
97
# Please see LICENSE.md for the full license document:
10-
# https://github.com/AdaptiveMotorControlLab/CEBRA/LICENSE.md
8+
# https://github.com/AdaptiveMotorControlLab/CEBRA/blob/main/LICENSE.md
9+
#
10+
# Licensed under the Apache License, Version 2.0 (the "License");
11+
# you may not use this file except in compliance with the License.
12+
# You may obtain a copy of the License at
13+
#
14+
# http://www.apache.org/licenses/LICENSE-2.0
15+
#
16+
# Unless required by applicable law or agreed to in writing, software
17+
# distributed under the License is distributed on an "AS IS" BASIS,
18+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19+
# See the License for the specific language governing permissions and
20+
# limitations under the License.
1121
#
1222
import argparse
1323
import json

0 commit comments

Comments
 (0)