Skip to content

Commit 58e8a50

Browse files
vlomonacogitbook-bot
authored andcommitted
GitBook: [master] one page modified
1 parent 857ff58 commit 58e8a50

File tree

1 file changed

+26
-52
lines changed

1 file changed

+26
-52
lines changed

Diff for: docs/gitbook/getting-started/how-to-install.md

+26-52
Original file line numberDiff line numberDiff line change
@@ -8,44 +8,42 @@ _Avalanche_ has been designed for extreme **portability** and **usability**. Ind
88

99
In order to install _Avalanche_ we have three main options:
1010

11-
1. [Installing it with Anaconda](how-to-install.md#install-avalanche-with-anaconda).
12-
2. [Installing it with Pip.](how-to-install.md#installing-avalanche-with-pip)
11+
1. [Installing it with Pip](how-to-install.md#installing-avalanche-with-pip)
12+
2. [Installing it with Anaconda](how-to-install.md#install-avalanche-with-anaconda)
1313
3. [Developer Mode Install](how-to-install.md#developer-mode-install) \(for contributing to _Avalanche_!\)
1414

1515
## 🔂 Avalanche Dependencies
1616

1717
The _Avalanche_ dependencies are the following:
1818

19-
`python>=3.6,<3.9`, `typing-extensions`, `psutil`, `torch`, `torchvision`, `tensorboard`, `scikit-learn`, `matplotlib`, `numpy`, `pytorchcv`, `quadprog`, `tqdm`, `googledrivedownloader`.
19+
`python>=3.6,<=3.9.2`, `typing-extensions`, `psutil`, `torch`, `torchvision`, `tensorboard`, `scikit-learn`, `matplotlib`, `numpy`, `pytorchcv`, `quadprog`, `tqdm`, `googledrivedownloader`.
2020

2121
{% hint style="info" %}
2222
_Avalanche may work on lower Python versions as well but we don't officially support it, nor recommend it._
2323
{% endhint %}
2424

2525
At the moment, we cannot provide a swift installation experience as some of the dependencies cannot be installed automatically. However, in the sections below we detail how you can install Avalanche **in a matter of minutes** on any platform!
2626

27-
## 🐍 Install Avalanche with Anaconda
27+
## 📦 Installing Avalanche with Pip
2828

29-
This is the safest option since it allows you to build an isolated environment for your Avalanche experiments. This means that you'll be able to pin particular versions of your dependencies that may differ from the ones you want to maintain in the rest of your system. This will in turn increase reproducibility of any experiment you may produce.
30-
31-
### **On Linux**
29+
Within an Anaconda environment or not you can install _Avalanche_ also with Pip with the following steps:
3230

33-
Assuming you have [Anaconda](https://www.anaconda.com/) installed on your system, if you can simply run the `install_script.sh` in the _Avalanche_ home directory. The script takes 2 arguments: `--python` and `--cuda_version`.
34-
35-
`--python` can take the values \[3.6, 3.7, 3.8\], default 3.8.
36-
`--cuda_version` can take the values \[9.2, 10.1, 10.2, 11.0, none\], default none.
31+
1. Install the package with pip.
32+
2. [Install Pytorch + TorchVision](https://pytorch.org/) \(follow the instructions on the website to use pip\)
3733

38-
For example:
34+
Step 1. can be done with the following line of code:
3935

4036
```bash
41-
bash -i ./install_environment.sh --python 3.8 --cuda_version 10.1
37+
pip install git+https://github.com/ContinualAI/avalanche.git
4238
```
4339

44-
You can test your installation by running the `examples/test_install.py` script. Make sure to include avalanche into your **$PYTHONPATH** if you are running examples with the command line interface.
40+
That's it. now we have _Avalanche_ up and running and we can start using it!
41+
42+
## 🐍 Install Avalanche with Anaconda
4543

46-
### On Windows or Mac OS
44+
This is the **safest option** since it allows you to build an isolated environment for your Avalanche experiments. This means that you'll be able to _pin particular versions_ of your dependencies that may differ from the ones you want to maintain in the rest of your system. This will in turn increase reproducibility of any experiment you may produce.
4745

48-
Assuming you have Anaconda installed on your system, you can follow these simple steps:
46+
Assuming you have **Anaconda \(or Miniconda\) installed** on your system, you can follow these simple steps:
4947

5048
1. Install the `avalanche.yml` environment and activate it.
5149
2. [Install Pytorch + TorchVision](https://pytorch.org/) \(follow the instructions on the website to use conda\)
@@ -67,47 +65,20 @@ conda activate avalanche-env
6765
# Istall Pytorch with Conda (instructions here: https://pytorch.org/)
6866

6967
# Step 3
70-
conda env update --file environment-dev.yml
71-
68+
conda env update --file environment.yml
7269
```
7370

74-
You can test your installation by running the `examples/test_install.py` script. Make sure to include avalanche into your **$PYTHONPATH** if you are running examples with the command line interface.
75-
76-
## 📦 Installing Avalanche with Pip
77-
78-
Within an Anaconda environment or not you can install _Avalanche_ also with Pip with the following steps:
79-
80-
1. Install the package with pip.
81-
2. [Install Pytorch + TorchVision](https://pytorch.org/) \(follow the instructions on the website to use pip\)
82-
83-
Step 1. can be done with the following line of code:
84-
85-
```bash
86-
pip install git+https://github.com/ContinualAI/avalanche.git
87-
```
71+
{% hint style="info" %}
72+
On **Linux**, alternatively, you can simply run the `install_environment.sh` in the _Avalanche_ home directory. The script takes 2 arguments: `--python` and `--cuda_version`. Check `--help` for details.
73+
{% endhint %}
8874

89-
That's it. now we have _Avalanche_ up and running and we can start using it!
75+
You can test your installation by running the `examples/test_install.py` script. Make sure to include avalanche into your **$PYTHONPATH** if you are running examples with the command line interface.
9076

9177
## 💻 Developer Mode Install
9278

93-
If you want to expand _Avalanche_ and help us improve it \(see the "[_From Zero to Hero_](../from-zero-to-hero-tutorial/2.-benchmarks.md)" Tutorial\). In this case we suggest to create an environment in _**developer-mode**_ as follows.
94-
95-
### **On Linux**
96-
97-
Assuming you have [Anaconda](https://www.anaconda.com/) installed on your system, if you can simply run the `install_script_dev.sh` in the _Avalanche_ home directory. The script takes 2 arguments: `--python` and `--cuda_version`.
98-
99-
`--python` can take the values \[3.6, 3.7, 3.8\], default 3.8.
100-
`--cuda_version` can take the values \[9.2, 10.1, 10.2, 11.0, none\], default none.
79+
If you want to expand _Avalanche_ and help us improve it \(see the "[_From Zero to Hero_](../from-zero-to-hero-tutorial/2.-benchmarks.md)" Tutorial\). In this case we suggest to create an environment in _**developer-mode**_ as follows \(just a couple of more dependencies will be installed\).
10180

102-
```bash
103-
bash -i ./install_environment_dev.sh --python 3.8 --cuda_version 10.1
104-
```
105-
106-
You can test your installation by running the `examples/test_install.py` script. Make sure to include avalanche into your **$PYTHONPATH** if you are running examples with the command line interface.
107-
108-
### **On Windows and Mac OS**
109-
110-
Assuming you have Anaconda installed on your system, you can follow these simple steps:
81+
Assuming you have **Anaconda \(or Miniconda\) installed** on your system, you can follow these simple steps:
11182

11283
1. Install the `avalanche-dev.yml` environment and activate it.
11384
2. [Install Pytorch + TorchVision](https://pytorch.org/) \(follow the instructions on the website to use conda\).
@@ -129,10 +100,13 @@ conda activate avalanche-dev-env
129100
# Istall Pytorch with Conda (instructions here: https://pytorch.org/)
130101

131102
# Step 3
132-
conda env update --file environment.yml
133-
103+
conda env update --file environment-dev.yml
134104
```
135105

106+
{% hint style="info" %}
107+
On **Linux**, alternatively, you can simply run the `install_environment_dev.sh` in the _Avalanche_ home directory. The script takes 2 arguments: `--python` and `--cuda_version`. Check `--help` for details.
108+
{% endhint %}
109+
136110
You can test your installation by running the `examples/test_install.py` script. Make sure to include avalanche into your **$PYTHONPATH** if you are running examples with the command line interface.
137111

138112
That's it. now we have _Avalanche_ up and running and we can start contribute to it!

0 commit comments

Comments
 (0)