Skip to content

Commit

Permalink
update installation guide
Browse files Browse the repository at this point in the history
  • Loading branch information
chiara-sophie committed Nov 10, 2023
1 parent c9c72ec commit ca97832
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions vizro-ai/docs/pages/user_guides/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ More details can be found in the [environment setup guide](../user_guides/api_se
To install Vizro-AI from the Python Package Index (PyPI), utilize [`pip`](https://pip.pypa.io/en/stable/) in your terminal with the following command:

```bash
pip install vizro-ai
pip install vizro_ai
```

While you can execute code from the tutorials and user guides using a Python script, using a Jupyter notebook is often considered more convenient. You can install `jupyter` with the following command:
Expand All @@ -50,9 +50,9 @@ pip install jupyter
After successfully installing Vizro-AI, to verify the version or confirm the installation, you can run the following code from a Python script or a Jupyter notebook cell:

```py
import vizro-ai
import vizro_ai

print(vizro-ai.__version__)
print(vizro_ai.__version__)
```

You should see a return output of the current version.
Expand All @@ -61,7 +61,7 @@ You should see a return output of the current version.

If you want to upgrade Vizro-AI to a different version later on, you can do so by running the following command:
```
pip install vizro-ai -U
pip install vizro_ai -U
```

The best way to safely upgrade is to check the [release notes]() for any notable breaking changes before migrating an
Expand Down

0 comments on commit ca97832

Please sign in to comment.