Getting Started#

Pre-Requisites#

To get Yawning-Titan installed, you will need to have the following installed:

Bash

  • python >= 3.8.*, <= 3.10.*

  • python3-pip

  • virtualenv

Powershell

  • python >= 3.8.*, <= 3.10.*

Yawning-Titan is designed to be OS-agnostic, and thus should work on most variations/distros of Linux, Windows, and MacOS.

Environment Setup#

Yawning-Titan operates from the users home directory where it has two locations, one hidden for backend stuff, and one user-facing for user files. To initialise this environment, run:

  • Bash
  • Powershell
mkdir ~/yawning_titan
cd ~/yawning_titan
python3 -m venv .venv
source .venv/bin/activate
pip install <path to downloaded yawningtitan .whl file>
yawning-titan setup

mkdir ~\yawning_titan
cd ~\yawning_titan
python3 -m venv .venv
attrib +h .venv /s /d # Hides the .venv directory
.\.venv\Scripts\activate
pip install <path to downloaded yawningtitan .whl file>
yawning-titan setup

Starting Yawning-Titan#

The best way to begin working with Yawning-Titan is to the GUI.

yawning-titan gui

See Yawning-Titan GUI Yawning-Titan GUI for a guide on how to use the GUI.

Alternatively, you can work with Yawning-Titan from Jupyter Labs.

yawning-titan notebooks

Running Yawning-Titan#

From a notebook in Jupyter Lab, import YawningTitanRun and instantiate it. This will run the YawningTitanRun using all default parameters. With auto=True, this will perform the .setup(), .train(), and .evaluate().

from yawning_titan.yawning_titan_run import YawningTitanRun

yt_run = YawningTitanRun()

The YawningTitanRun class is fully configurable. Check out the YawningTitanRun docs for further customisation.

Development Install#

For those wishing to install Yawning-Titan and use it or extend it from within an IDE, perform the following development installation:

2. Activate the venv#

  • Bash
  • Powershell
source venv/bin/activate

.\venv\Scripts\activate

3. Install Yawning-Titan into the venv along with all of its dependencies#

python3 -m pip install -e .[dev]