Skip to content

Commit

Permalink
Merge pull request #9752 from RasaHQ/install-quick-wins
Browse files Browse the repository at this point in the history
Install quick wins
  • Loading branch information
TyDunn authored Oct 6, 2021
2 parents f211b0a + 40fedc8 commit 52f036c
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 4 deletions.
1 change: 1 addition & 0 deletions changelog/9782.doc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Updates [quick install documentation](installation.mdx#quick-installation) with optional venv step, better pip install instructions, & M1 warning
63 changes: 59 additions & 4 deletions docs/docs/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,77 @@ your machine and continue development locally.

## Quick Installation

You can install Rasa Open Source using pip (requires Python 3.6, 3.7 or 3.8).
**Isolate your python project using a virtual environment.**

<Tabs values={[{"label": "Ubuntu", "value": "ubuntu"}, {"label": "macOS", "value": "macos"}, {"label": "Windows", "value": "windows"}]} groupId="operating-systems" defaultValue="ubuntu">
<TabItem value="ubuntu">

Create a new virtual environment by choosing a Python interpreter and making a `./venv` directory to hold it:

```bash
python3 -m venv ./venv
```

Activate the virtual environment:

```bash
source ./venv/bin/activate
```

</TabItem>
<TabItem value="macos">

Create a new virtual environment by choosing a Python interpreter and making a `./venv` directory to hold it:

```bash
python3 -m venv ./venv
```

Activate the virtual environment:

```bash
source ./venv/bin/activate
```

</TabItem>
<TabItem value="windows">

Create a new virtual environment by choosing a Python interpreter and making a `.\\venv` directory to hold it:

```bat
C:\> python3 -m venv ./venv
```

Activate the virtual environment:

```bat
C:\> .\venv\Scripts\activate
```

</TabItem>
</Tabs>

**Install Rasa Open Source using pip (requires Python 3.6, 3.7, or 3.8).**

```bash
pip3 install -U --user pip
```

```bash
pip3 install -U pip
pip3 install rasa
```

You are now ready to go! So what's next?
You can create a new project by running:
**You are now ready to go! So what's next? You can create a new project by running:**

```bash
rasa init
```

You can learn about the most important Rasa commands in the [Command Line Interface](./command-line-interface.mdx).

:::note
Due to lack of official TensorFlow support for the Apple M1, Rasa Open Source is currently unable to train a model using M1.
:::

## Step-by-step Installation Guide

Expand Down

0 comments on commit 52f036c

Please sign in to comment.