Release 0.5.0rc1 (#189)

* Make bump_version script runnable on MacOS

* Bump version to 0.5.0rc1

* fix minor formatting issues

* remove commented code

---------

Co-authored-by: Mackenzie Mathis <[email protected]>

Author: stes

Dockerfile

@@ -40,7 +40,7 @@ RUN make dist
 FROM cebra-base
 
 # install the cebra wheel
-ENV WHEEL=cebra-0.4.0-py2.py3-none-any.whl
+ENV WHEEL=cebra-0.5.0rc1-py2.py3-none-any.whl
 WORKDIR /build
 COPY --from=wheel /build/dist/${WHEEL} .
 RUN pip install --no-cache-dir ${WHEEL}'[dev,integrations,datasets]'

Makefile

@@ -1,4 +1,4 @@
-CEBRA_VERSION := 0.4.0
+CEBRA_VERSION := 0.5.0rc1
 
 dist:
 	python3 -m pip install virtualenv

PKGBUILD

@@ -1,7 +1,7 @@
 # Maintainer: Steffen Schneider <[email protected]>
 pkgname=python-cebra
 _pkgname=cebra
-pkgver=0.4.0
+pkgver=0.5.0rc1
 pkgrel=1
 pkgdesc="Consistent Embeddings of high-dimensional Recordings using Auxiliary variables"
 url="https://cebra.ai"

cebra/__init__.py

@@ -66,7 +66,7 @@
 
 import cebra.integrations.sklearn as sklearn
 
-__version__ = "0.4.0"
+__version__ = "0.5.0rc1"
 __all__ = ["CEBRA"]
 __allow_lazy_imports = False
 __lazy_imports = {}

cebra/integrations/sklearn/cebra.py

@@ -51,7 +51,6 @@
     np.dtypes.Float64DType, np.dtypes.Int64DType
 ]
 
-
 def check_version(estimator):
     # NOTE(stes): required as a check for the old way of specifying tags
     # https://github.com/scikit-learn/scikit-learn/pull/29677#issuecomment-2334229165
@@ -77,6 +76,7 @@ def _safe_torch_load(filename, weights_only, **kwargs):
     return checkpoint
 
 
+
 def _init_loader(
     is_cont: bool,
     is_disc: bool,

docs/source/conf.py

@@ -28,18 +28,13 @@
 
 # -- Path setup --------------------------------------------------------------
 
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
+import datetime
 import os
 import sys
 
 sys.path.insert(0, os.path.abspath("."))
 
-import datetime
-
-import cebra
+import cebra  # noqa: E402
 
 
 def get_years(start_year=2021):
@@ -156,11 +151,6 @@ def get_years(start_year=2021):
             "url": "https://twitter.com/cebraAI",
             "icon": "fab fa-twitter",
         },
-        # {
-        #     "name": "DockerHub",
-        #     "url": "https://hub.docker.com/r/stffsc/cebra",
-        #     "icon": "fab fa-docker",
-        # },
         {
             "name": "PyPI",
             "url": "https://pypi.org/project/cebra/",
@@ -247,6 +237,9 @@ def get_years(start_year=2021):
 
 # Download link for the notebook, see
 # https://nbsphinx.readthedocs.io/en/0.3.0/prolog-and-epilog.html
+
+# fmt: off
+# flake8: noqa: E501
 nbsphinx_prolog = r"""
 
 .. only:: html
@@ -269,3 +262,5 @@ def get_years(start_year=2021):
 
 ----
 """
+# fmt: on
+# flake8: enable=E501

reinstall.sh

@@ -15,7 +15,7 @@ pip uninstall -y cebra
 # Get version info after uninstalling --- this will automatically get the
 # most recent version based on the source code in the current directory.
 # $(tools/get_cebra_version.sh)
-VERSION=0.4.0
+VERSION=0.5.0rc1
 echo "Upgrading to CEBRA v${VERSION}"
 
 # Upgrade the build system (PEP517/518 compatible)

tools/bump_version.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 # Bump the CEBRA version to the specified value.
 # Edits all relevant files at once.
-# 
+#
 # Usage:
 # tools/bump_version.sh 0.3.1rc1
 
@@ -10,24 +10,36 @@ if [ -z ${version} ]; then
     >&1 echo "Specify a version number."
     >&1 echo "Usage:"
     >&1 echo "tools/bump_version.sh <semantic version>"
+    exit 1
+fi
+
+# Determine the correct sed command based on the OS
+# On macOS, the `sed` command requires an empty string argument after `-i` for in-place editing.
+# On Linux and other Unix-like systems, the `sed` command only requires `-i` for in-place editing.
+if [[ "$OSTYPE" == "darwin"* ]]; then
+    # macOS
+    SED_CMD="sed -i .bkp -e"
+else
+    # Linux and other Unix-like systems
+    SED_CMD="sed -i -e"
 fi
 
 # python cebra version
-sed -i "s/__version__ = .*/__version__ = \"${version}\"/" \
-    cebra/__init__.py
+$SED_CMD "s/__version__ = .*/__version__ = \"${version}\"/" cebra/__init__.py
 
 # reinstall script in root
-sed -i "s/VERSION=.*/VERSION=${version}/" \
-    reinstall.sh
+$SED_CMD "s/VERSION=.*/VERSION=${version}/" reinstall.sh
 
 # Makefile
-sed -i "s/CEBRA_VERSION := .*/CEBRA_VERSION := ${version}/" \
-    Makefile
+$SED_CMD "s/CEBRA_VERSION := .*/CEBRA_VERSION := ${version}/" Makefile
 
-# Arch linux PKGBUILD 
-sed -i "s/pkgver=.*/pkgver=${version}/" \
-    PKGBUILD 
+# Arch linux PKGBUILD
+$SED_CMD "s/pkgver=.*/pkgver=${version}/" PKGBUILD
 
 # Dockerfile
-sed -i "s/ENV WHEEL=cebra-.*\.whl/ENV WHEEL=cebra-${version}-py2.py3-none-any.whl/" \
-    Dockerfile 
+$SED_CMD "s/ENV WHEEL=cebra-.*\.whl/ENV WHEEL=cebra-${version}-py2.py3-none-any.whl/" Dockerfile
+
+# Remove backup files
+if [[ "$OSTYPE" == "darwin"* ]]; then
+    rm cebra/__init__.py.bkp reinstall.sh.bkp Makefile.bkp PKGBUILD.bkp Dockerfile.bkp
+fi