Installing `relationalai` Locally#

This guide shows you how to install the relationalai package into a local Python environment.

Install Python and the `relationalai` package#

Follow the steps for your operating system to install Python and the relationalai package.

NOTE

The relationalai Python package requires Python 3.9, 3.10, or 3.11. If you have an existing compatible Python installation, skip to the last step below.

Navigate to the Python 3.11 download page, scroll down to the Files section, and download the macOS 64-bit universal2 installer.
Open the installer and follow the prompts to install Python 3.11. Use the default installation options. When the installation is complete, double click the Install Certificates command in the Finder window.
Open a terminal and verify that Python 3.11 is installed by running:
```
#python3.11 --version
```
The output should be similar to Python 3.11.9.
Create a new project directory and virtual environment and use pip to install the relationalai package:
```
#mkdir rai-getting-started && cd rai-getting-started

# Replace `python3.11` with `python3.9` or `python3.10`
# if you're using a different version.
python3.11 -m venv .venv  # Create a virtual environment.
source .venv/bin/activate  # Activate the virtual environment.

python -m pip install relationalai
```
Activating your virtual environment adds .venv/bin to your PATH, so you can use its Python executable as python.

TIP
Activate your virtual environment each time you open a new terminal to use the correct Python version and access the relationalai package.

Navigate to the Python 3.11 download page, scroll down to the Files section, and download the Windows installer (64-bit).
Open the installer and follow the prompts to install Python 3.11. Check the box to add Python to your PATH.
Open a terminal and verify that Python 3.11 is installed by running:
```
#python3.11 --version
```
The output should be similar to Python 3.11.9.
Create a new project directory and virtual environment and use pip to install the relationalai package:
```
#mkdir rai-getting-started && cd rai-getting-started

# Replace `python3.11` with `python3.9` or `python3.10`
# if you're using a different version.
python3.11 -m venv .venv  # Create a virtual environment.
.venv\Scripts\activate  # Activate the virtual environment.

python -m pip install relationalai
```
Activating your virtual environment adds .venv/bin to your PATH, so you can use its Python executable as python.

TIP
Activate your virtual environment each time you open a new terminal to use the correct Python version and access the relationalai package.

Use your distribution’s package manager to install Python 3.11. Alternatively, navigate to the Python 3.11 download page, scroll down to the Files section, download the Gzipped source tarball and compile it yourself. See the Python documentation for details.
Open a terminal and verify that Python 3.11 is installed by running:
```
#python3.11 --version
```
The output should be similar to Python 3.11.9.
Create a new project directory and virtual environment and use pip to install the relationalai package:
```
#mkdir rai-getting-started && cd rai-getting-started

# Replace `python3.11` with `python3.9` or `python3.10`
# if you're using a different version.
python3.11 -m venv .venv  # Create a virtual environment.
source .venv/bin/activate  # Activate the virtual environment.

python -m pip install relationalai
```
Activating your virtual environment adds .venv/bin to your PATH, so you can use its Python executable as python.

TIP
Activate your virtual environment each time you open a new terminal to use the correct Python version and access the relationalai package.

Configure your project#

Run rai init to connect to your Snowflake account and configure a new model:

#rai init

Follow the interactive prompts to enter your Snowflake credentials and choose the:

Snowflake role: Must have SELECT privileges on the Snowflake tables you’ll be accessing as well as the eng_admin and all_schema_all RAI application roles.
Snowflake warehouse: May be any warehouse.
RAI native app: The default is relationalai, but yours may differ.
RAI engine: Required to run a RAI model. Choose an existing engine from the list or select [CREATE ENGINE] to create a new engine by selecting a size and compute pool. See Engine Management for more information.

IMPORTANT

rai init saves your model’s configuration to a file named raiconfig.toml in the current directory. This file contains sensitive information, so be sure to exclude it from version control!

Test your installation#

To verify that your model is configured correctly, open a Python editor or notebook and run:

#import relationalai as rai

# Create a model named "power_transmission_network".
model = rai.Model("power_transmission_network")

# Send a test query.
with model.query() as select:
    response = select(1 + 1)

# The results are stored as a pandas DataFrame in the `results` attribute.
print(response.results)
# Output:
#    v
# 0  2

Next steps#

To begin exploring RelationalAI’s capabilities, check out the Getting Started guide or the Example Notebooks.

Installing relationalai Locally#

Install Python and the relationalai package#

Configure your project#

Test your installation#

Next steps#

Installing `relationalai` Locally#

Install Python and the `relationalai` package#