diff --git a/CHANGELOG.md b/CHANGELOG.md index d04ab82f..fc677e47 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -45,10 +45,10 @@ refers to `DeterministicGlobalWorkspace`. * Add docs in `docs/`, API documentation in https://ruflab.github.io/shimmer/, and some code examples. * Replace Black, isort, and flake8 with Ruff (see - https://github.com/bdvllrs/shimmer/pull/8). + https://github.com/ruflab/shimmer/pull/8). * Remove `GWInterfaces` entirely and favor giving encoders and decoders directly to the `GWModule`. See the updated example `examples/main_example/train_gw.py` to see what - changes to make (see https://github.com/bdvllrs/shimmer/pull/9). + changes to make (see https://github.com/ruflab/shimmer/pull/9). * Remove `GWModuleBase.translate` and `GWModuleBase.cycle`. Translation and cycles can now be done with the utils function `translation` and `cycle`. * Remove `GlobalWorkspaceBase.batch_demi_cycles`, `GlobalWorkspaceBase.batch_cycles`, diff --git a/docs/installation.md b/docs/installation.md index 4da38097..7583f553 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -4,20 +4,20 @@ You can directly use shimmer as a dependency to your project. However, there is no PyPI entry yet, so you will need to install it as a git dependency: ```sh -pip install git+https://github.com/bdvllrs/shimmer.git@version +pip install git+https://github.com/ruflab/shimmer.git@version ``` You can choose to use a specific version -(look at the latest releases: https://github.com/bdvllrs/shimmer/releases) or +(look at the latest releases: https://github.com/ruflab/shimmer/releases) or use the main branch for latest development: ```sh -pip install git+https://github.com/bdvllrs/shimmer.git@main +pip install git+https://github.com/ruflab/shimmer.git@main ``` You can add the dependency directly in your `requirements.txt`: ``` -shimmer@git+https://github.com/bdvllrs/shimmer.git@main +shimmer@git+https://github.com/ruflab/shimmer.git@main ``` Or in your `pyproject.toml` following your package manager instructions. @@ -25,7 +25,7 @@ This project uses [poetry](https://python-poetry.org/). Using poetry, you can add: ```toml -shimmer = {git = "git@github.com:bdvllrs/shimmer.git", rev = "main"} +shimmer = {git = "git@github.com:ruflab/shimmer.git", rev = "main"} ``` in the `tool.poetry.dependencies` section.