Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
isikus committed Aug 2, 2021
1 parent 337ebed commit 4157b56
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ Powered by [Text-To-Text Transfer Transformer](https://github.com/google-researc
* If you want to **reproduce our scores**, refer to the **Measure performance** section at the end of each corresponding notebook ([`tiny`](https://colab.research.google.com/github/lcl-hse/heptabot/blob/cpu/notebooks/Run_tiny_model_on_Colab_CPU.ipynb#scrollTo=HH35ksIc5qj6), [`medium`](https://colab.research.google.com/github/lcl-hse/heptabot/blob/gpu-tpu/notebooks/Run_medium_model_on_Colab_GPU.ipynb#scrollTo=HH35ksIc5qj6), [`xxl`](https://www.kaggle.com/isikus/run-heptabot-xxl-model-on-tpu?scriptVersionId=69426878&cellId=32)).

**For cloning `heptabot` onto your hardware, we suggest using our Docker images, as our former installation procedures were too complicated to follow and are now deprecated.**
* If you want to **install our CPU (`tiny`) version/clone our Web demo**, pull our [`tiny-cpu` Docker image](https://hub.docker.com/r/lclhse/heptabot/): `docker pull lclhse/heptabot` (our legacy [Install](https://github.com/lcl-hse/heptabot/blob/cpu/legacy/Install.ipynb) procedure is deprecated).
* If you want to **install our GPU (`medium`) version/set up a Web version of `medium` model** (and you have a GPU), pull our [`medium-gpu` Docker image](https://hub.docker.com/r/lclhse/heptabot/): `docker pull lclhse/heptabot:medium-gpu` (our legacy [Install](https://github.com/lcl-hse/heptabot/blob/gpu-tpu/legacy/Install.ipynb) procedure is deprecated).
* To boot the image as a Web service, use `docker run -d -p 5000:80 -p 5000:443 lclhse/heptabot "source activate heptabot; ./start.sh; bash"` and wait for around 75 seconds. In order to stop `heptabot`, just kill the container using `docker container kill $(docker container ps -q -f ancestor=lclhse/heptabot)`.
* If you want to **install our CPU (`tiny`) version/clone our Web demo**, pull our [`tiny-cpu` Docker image](https://hub.docker.com/layers/lclhse/heptabot/tiny-cpu/images/sha256-030e21180f80b754b037de09b1f86f0d9d7601cdbf68782ecbf9869d6247756a): `docker pull lclhse/heptabot` (our legacy [Install](https://github.com/lcl-hse/heptabot/blob/cpu/legacy/Install.ipynb) procedure is deprecated).
* If you want to **install our GPU (`medium`) version/set up a Web version of `medium` model** (and you have a GPU), pull our [`medium-gpu` Docker image](https://hub.docker.com/layers/lclhse/heptabot/medium-gpu/images/sha256-3290267a1b9e3b4b5cac10e46ff8365e5d7ea3da3c8555e6454ede640f975048): `docker pull lclhse/heptabot:medium-gpu` (our legacy [Install](https://github.com/lcl-hse/heptabot/blob/gpu-tpu/legacy/Install.ipynb) procedure is deprecated).
* To boot the image as a Web service, use `docker run -td -p 80:5000 -p 443:5000 lclhse/heptabot "source activate heptabot; ./start.sh; bash"` and wait for around 75 seconds. In order to stop `heptabot`, just kill the container using `docker container kill $(docker container ps -q -f ancestor=lclhse/heptabot)`.
* To use the image internally, connect to it like `docker run -it lclhse/heptabot bash` or connect to an externally deployed version on e. g. [vast.ai](https://vast.ai/). Once connected to the terminal, run `source activate heptabot` and start Jupyter Lab: you will see our example notebook in the root directory. To kill `heptabot` inside the running container, you may use `kill $(lsof | grep -oP "^\S+\s+\K([0-9]+)(?=\s+(?![0-9]).*?9090)" | xargs -n1 | sort -u | xargs)`. In order to restart `heptabot` after that, use `./start.sh` or, if running in Jupyter Lab, use `prompt_run.sh` generated in the notebook.

## Performance
Expand Down

0 comments on commit 4157b56

Please sign in to comment.