Skip to content

Commit

Permalink
update links part 2
Browse files Browse the repository at this point in the history
  • Loading branch information
bdvllrs committed Sep 23, 2024
1 parent 9217625 commit 203572a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`,
Expand Down
10 changes: 5 additions & 5 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,28 @@ 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.
This project uses [poetry](https://python-poetry.org/).

Using poetry, you can add:
```toml
shimmer = {git = "[email protected]:bdvllrs/shimmer.git", rev = "main"}
shimmer = {git = "[email protected]:ruflab/shimmer.git", rev = "main"}
```

in the `tool.poetry.dependencies` section.
Expand Down

0 comments on commit 203572a

Please sign in to comment.