Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Nebuly authored May 30, 2022
1 parent 632dee9 commit 6b5d0ca
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,19 +112,20 @@ We suggest testing the library on your AI models right away by following the ins

There are two ways to install `nebullvm`:

1. Using PyPI. We suggest installing the library with `pip` to get the stable
- Step 1-A: Using PyPI. We suggest installing the library with `pip` to get the stable
version of `nebullvm`
2. From source code to get the latest features

- Step 1-B: From source code to get the latest features

#### Option 1A: Installation with PyPI (recommended)
#### Step 1-A: Installation with PyPI (recommended)

The easiest way to install `nebullvm` is by using `pip`, running

```
pip install nebullvm
```

#### Option 1B: Source code installation
#### Step 1-B: Source code installation

To install the source code you have to clone the directory on your local machine
using `git`.
Expand All @@ -147,17 +148,17 @@ pip install .

Now you need to install the compilers that the library leverages to create the
optimized version of your models. We have built an auto-installer to install them
automatically.
automatically. We propose 3 options (2-A, 2-B and 2-C) to achieve this goal.

#### Option 2A: Installation at the first optimization run
#### Step 2-A: Installation at the first optimization run

The auto-installer is activated after you import `nebullvm` and perform your
first optimization. You may run into import errors related to the deep learning
compiler installation, but you can ignore these errors/warnings.
It is also recommended restarting the python kernel between the auto-installation
and the first optimization, otherwise not all compilers will be activated.

#### Option B: Installation before the first optimization run (recommended)
#### Step 2-B: Installation before the first optimization run (recommended)

To avoid any problems, we strongly recommend running the auto-installation
before performing the first optimization by running
Expand All @@ -169,7 +170,7 @@ python -c "import nebullvm"
You should ignore at this stage any import warning resulting from the previous
command.

#### Option 2C: Selective installation of deep learning compilers
#### Step 2-C: Selective installation of deep learning compilers

The library automatically installs all deep learning compilers it supports. In case you would be interested in bypassing the automatic installation, you can export the environment variable
`NO_COMPILER_INSTALLATION=1` by running
Expand Down

0 comments on commit 6b5d0ca

Please sign in to comment.