Skip to content

Commit

Permalink
#69 Update README (#146)
Browse files Browse the repository at this point in the history
  • Loading branch information
Only-bottle authored Feb 2, 2024
1 parent d9ee1d0 commit ceb1013
Show file tree
Hide file tree
Showing 3 changed files with 429 additions and 151 deletions.
54 changes: 54 additions & 0 deletions INSTALLATION.md
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)
```
Loading

0 comments on commit ceb1013

Please sign in to comment.