Skip to content
This repository has been archived by the owner on Nov 3, 2023. It is now read-only.

Commit

Permalink
Rework Installation Instructions (#5015)
Browse files Browse the repository at this point in the history
- Add some structure to the texts regarding the operating system, Python interpreter, and virtual environment
- Reformat end user and developer installation headings to use markdown ATX-style headers
- Extend instructions to use a virtual environment like recommended in the text
  • Loading branch information
Bengt authored Jun 5, 2023
1 parent 22190f4 commit 86ec735
Showing 1 changed file with 25 additions and 9 deletions.
34 changes: 25 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,30 +58,46 @@ For those who want to start with ParlAI now, you can try our [Colab Tutorial](ht

## Installing ParlAI

ParlAI currently requires Python3.8+ and [Pytorch](https://pytorch.org) 1.6 or higher.
Dependencies of the core modules are listed in [`requirements.txt`](https://github.com/facebookresearch/ParlAI/blob/main/requirements.txt). Some
models included (in [`parlai/agents`](https://github.com/facebookresearch/ParlAI/tree/main/parlai/agents)) have additional requirements.
We *strongly* recommend you install ParlAI in a [venv](https://docs.python.org/3/library/venv.html) or [conda](https://www.anaconda.com/) environment.
### Operating System

We do not support Windows at this time, but many users [report success on Windows using Python 3.8](https://github.com/facebookresearch/ParlAI/issues/3989) and issues with Python 3.9. We are happy to accept patches that improve Windows support.
ParlAI should work as inteded under Linux or macOS. We do not support Windows at this time, but many users [report success on Windows using Python 3.8](https://github.com/facebookresearch/ParlAI/issues/3989) and issues with Python 3.9. We are happy to accept patches that improve Windows support.

**Standard Installation**
### Python Interpreter

ParlAI currently requires Python3.8+.

### Requirements

ParlAI supports [Pytorch](https://pytorch.org) 1.6 or higher.
All requirements of the core modules are listed in [`requirements.txt`](https://github.com/facebookresearch/ParlAI/blob/main/requirements.txt). However, some models included (in [`parlai/agents`](https://github.com/facebookresearch/ParlAI/tree/main/parlai/agents)) have additional requirements.

## Virtual Environment

We *strongly* recommend you install ParlAI in a virtual environment using [venv](https://docs.python.org/3/library/venv.html) or [conda](https://www.anaconda.com/).

### End User Installation

If you want to use ParlAI without modifications, you can install it with:

```bash
pip install parlai
cd /path/to/your/parlai-app
python3.8 -m venv venv
venv/bin/pip install --upgrade pip setuptools wheel
venv/bin/pip install parlai
```

**Development Installation**
### Developer Installation

Many users will want to modify some parts of ParlAI. To set up a development
environment, run the following commands to clone the repository and install
ParlAI:

```bash
git clone https://github.com/facebookresearch/ParlAI.git ~/ParlAI
cd ~/ParlAI; python setup.py develop
cd ~/ParlAI
python3.8 -m venv venv
venv/bin/pip install --upgrade pip setuptools wheel
venv/bin/python setup.py develop
```

> **Note**
Expand Down

0 comments on commit 86ec735

Please sign in to comment.