OuterRail 1.2.1

AIoD - RAIL. SDK for the RAIL service of the AI on Demand platform.

OuterRail

An SDK for AI on Demand RAIL platform.

What is RAIL

RAIL stands for: Research and Innovation AI Lab

RAIL is a tool that allows AI practitioners to explore and use AI assets directly in the AI on Demand platform (AIoD). RAIL is developed within the AI4Europe project as one of the core services of the AI on Demand platform.

OuterRail organization

SDK provides two types of interfaces:

• Instances - are classes that provide a way to work with individual instances of different parts of RAIL, e. g. individual templates, experiments, runs, datasets
• Managers - contain operations that function on multiple instances, such as querying, counting,... Special case that is also handled by managers is creation of new Instances.

Installation

Requirements

Python 3.11+

pip install

The OuterRail package can simply be installed with pip via command:

pip install OuterRail

Manual installation with wheel

Usage

Importing the package

You can import the SDK with:

import OuterRail

In code setup

Importing the package

You can the entire SDK with:

import OuterRail

Alternatively, you can import only needed parts with:

from OuterRail import what_you_need

Config and Logging in

For the SDK to work with underlying RAIL backend, you need to specify the URL of the RAIL service. Additionally, most of the functionality requires authentication, and therefore you need to be logged in to use this functionality.
Logging in will require entering a device code on the provided URL, where afterwards you will be log in to the service and give consent to resources needed by the SDK.

The code for this would look something like:

import os
from OuterRail import Configuration

config = Configuration(host="https://rail.aiod.eu/api/docs") # 1. Specify URL
config.login() # 2. Blocking function until log in or timeout
# ... your logic here ...
config.logout() # 3. After your code, logout

Examples

For more examples, you can check out the following sources:

• RAIL - with example code for using the SDK
• Official documentation
• Docstrings in the SDK itself

Author

This SDK was created at KInIT by Jozef Barut.