-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d9ee1d0
commit ceb1013
Showing
3 changed files
with
429 additions
and
151 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
## Installation | ||
|
||
### Prerequisites | ||
|
||
- Python `3.8` | `3.9` | `3.10` | ||
- PyTorch `1.13.0` (recommended) (compatible with: `1.11.x` - `1.13.x`) | ||
- TensorFlow `2.8.0` (recommended) (compatible with: `2.3.x` - `2.8.x`) | ||
|
||
### Install with PyPI (stable) | ||
|
||
```bash | ||
pip install netspresso | ||
``` | ||
|
||
### Install with GitHub | ||
|
||
To install with editable mode, | ||
|
||
```bash | ||
git clone https://github.com/nota-netspresso/pynetspresso.git | ||
cd pynetspresso | ||
pip install -e . | ||
``` | ||
|
||
### Docker with docker-compose | ||
|
||
For the latest information, please check `docker-compose.yml` | ||
|
||
```python | ||
# run command | ||
export TAG=v$(cat netspresso/VERSION) && \ | ||
docker compose run --service-ports --name netspresso-dev netspresso bash | ||
``` | ||
|
||
### Docker image build | ||
|
||
If you run with `docker run` command, follow the image build and run command in the below: | ||
|
||
```python | ||
# build an image | ||
docker build -t netspresso:v$(cat netspresso/VERSION) . | ||
``` | ||
|
||
```python | ||
# docker run command | ||
docker run -it --ipc=host\ | ||
--gpus='"device=0,1,2,3"'\ | ||
-v /PATH/TO/DATA:/DATA/PATH/IN/CONTAINER\ | ||
-v /PATH/TO/CHECKPOINT:/CHECKPOINT/PATH/IN/CONTAINER\ | ||
-p 50001:50001\ | ||
-p 50002:50002\ | ||
-p 50003:50003\ | ||
--name netspresso-dev netspresso:v$(cat netspresso/VERSION) | ||
``` |
Oops, something went wrong.