Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
lala8 committed Apr 29, 2024
1 parent a1b7d4a commit 21281fc
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 37 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Changelog

## Version 0.1
## Version 1.0

- Initial release.
39 changes: 3 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,54 +6,21 @@ gReLU is a python library to train, interpret, and apply deep learning models to

## Installation

To install the package:

```shell
pip install \
--trusted-host pypi.vida.science.roche.com \
--extra-index-url https://pypi.vida.science.roche.com/simple/ \
grelu
```

To upgrade the package:


```shell
pip install \
--upgrade \
--trusted-host pypi.vida.science.roche.com \
--extra-index-url https://pypi.vida.science.roche.com/simple/ \
grelu
```

To install from source:

```shell
git clone https://code.roche.com/braid-relu/grelu.git
cd grelu
git clone https://github.com/Genentech/gReLU.git
cd gReLU
pip install .
```

## Rosalind

`grelu` is available on `Rosalind` in managed environments.

```shell
ml spaces/gpy
ml gpyprd/gpy39 # available on Py 3.9 and 3.10 environments
```

We recommend using Volta GPUs on Rosalind to avoid CUDA issues. This can be achieved via the `--gres=gpu:volta:1` SLURM option in the command line or on the Advanced Slurm Options section of the Rosalind Portal.

For details on all possibilities, see [this Slack channel](https://gred.slack.com/archives/tool-grelu).

## Contributing

This project uses [pre-commit](https://pre-commit.com/). Please make sure to install it before making any changes:

```shell
pip install pre-commit
cd grelu
cd gReLU
pre-commit install
```

Expand Down

0 comments on commit 21281fc

Please sign in to comment.