Skip to content

Commit 0e9cd4c

Browse files
committed
update README.md for release
1 parent a821e6b commit 0e9cd4c

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ Then, install PyTorch by following the instructions
4545
the installation command suitable for your operating system, Python
4646
package manager, and whether you want to use it on a CPU or GPU.
4747

48-
Next, clone the Roosterize repository and enter the directory:
48+
Next, either download a Roosterize [release][releases-link]
49+
or clone the Roosterize repository and enter the directory:
4950
```
5051
git clone https://github.com/EngineeringSoftware/roosterize.git
5152
cd roosterize
@@ -57,24 +58,31 @@ Python installation):
5758
pip install -r requirements.txt
5859
```
5960

61+
[releases-link]: https://github.com/EngineeringSoftware/roosterize/releases
62+
6063
### Download pre-trained models
6164

62-
Roosterize's pre-trained models are available via this Google Drive
63-
[link](https://drive.google.com/file/d/1L0-BMOrP0WYX7L1bAhKRkJPLm7VPeMsE/view?usp=sharing).
64-
Download the file `models.tgz` from the link and put it under this
65-
directory, then uncompress the file:
65+
Roosterize's pre-trained models are available for separate [download][models-link].
66+
Put the archive with the models (`models.tgz`) in the `roosterize`
67+
directory, and then uncompress it:
6668
```
6769
tar xzf models.tgz
6870
```
6971

72+
[models-link]: https://github.com/EngineeringSoftware/roosterize/releases/download/v8.10.0/models.tgz
73+
7074
### Usage
7175

7276
To use Roosterize on a Coq verification project, you need to first
7377
build and install the project with the command provided by the project
7478
(usually `make` followed by `make install`). Then, at the root directory of
7579
the project repository, run the command
7680
```
77-
python -m roosterize.main suggest_lemmas --project=$PATH_TO_PROJECT --serapi_options=$SERAPI_OPTIONS --model-dir=./models/roosterize-ta --output=./output
81+
python -m roosterize.main suggest_lemmas \
82+
--project=$PATH_TO_PROJECT \
83+
--serapi_options=$SERAPI_OPTIONS \
84+
--model-dir=./models/roosterize-ta \
85+
--output=./output
7886
```
7987
where `$PATH_TO_PROJECT` should be replaced with the path to the
8088
project, and `$SERAPI_OPTIONS` should be replaced with the SerAPI

0 commit comments

Comments
 (0)