Example Notebooks#
Explore our collection of example Jupyter notebooks. These demos provide practical, hands-on examples to help you understand and apply RelationalAI’s powerful features to your own data problems.
For instructions on how to run these notebooks, see the Instructions section below.
Domain Examples#
Complete examples of practical use-cases.
Graph Algorithms#
Concise examples, each showcasing a specific graph algorithm.
Instructions#
To run one of the notebooks above, follow the steps below.
Install Python and the relationalai package#
Follow the steps for your operating system to install Python and the relationalai package.
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 --versionThe output should be similar to
Python 3.11.9. -
Create a new project directory and virtual environment and use
pipto install therelationalaipackage:#
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 relationalaiActivating your virtual environment adds
.venv/binto yourPATH, so you can use its Python executable aspython.TIPActivate your virtual environment each time you open a new terminal to use the correct Python version and access the
relationalaipackage.
-
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 --versionThe output should be similar to
Python 3.11.9. -
Create a new project directory and virtual environment and use
pipto install therelationalaipackage:#
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 relationalaiActivating your virtual environment adds
.venv/binto yourPATH, so you can use its Python executable aspython.TIPActivate your virtual environment each time you open a new terminal to use the correct Python version and access the
relationalaipackage.
-
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 --versionThe output should be similar to
Python 3.11.9. -
Create a new project directory and virtual environment and use
pipto install therelationalaipackage:#
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 relationalaiActivating your virtual environment adds
.venv/binto yourPATH, so you can use its Python executable aspython.TIPActivate your virtual environment each time you open a new terminal to use the correct Python version and access the
relationalaipackage.
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
SELECTprivileges on the Snowflake tables you’ll be accessing as well as theeng_adminandall_schema_allRAI 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.
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!
Install Jupyter and run the notebook#
- After running the steps above to create and activate a virtual environment, run the following to install Jupyter and to trust the notebook file. Trusting the file enables the graph visualizations to display when the notebook is opened.
# python -m pip install jupyter jupyter trust *.ipynb - Start a Jupyter server. This will open a browser window with the Jupyter Lab interface:
# jupyter lab - Open the notebook file in Jupyter Lab and run the cells. If the data for the example has not already been loaded in your Snowflake account, you’ll need to go to the Appendix and run the data-loading operations before running the main cells.