Ryax Documentation

Ryax is an open-source platform that enables the design, deployment, and monitoring of your data analytics, Cloud automations and GenAI applications.

Ryax makes the creation and execution of GenAI and data analytics apps more accessible to all types of developers. It enables users to execute their GenAI and data analytics applications across the Edge/Cloud/HPC continuum seamlessly. It provides smart scheduling capabilities while abstracting the complexity of managing applications in production.

This is the best place to start with Ryax. In the following sections we cover what Ryax is, what problems it can solve, and how it compares to existing software.

Need a quick crash course? Jump right in our Quick Start Guide

What is Ryax?

Concepts

• Introduction
  • Ryax main advantages
  • Ryax principal functionalities
  • Ryax Roadmap and upcoming features
  • Ryax background, motivation and added value
• Workflows, Actions and Runs
  • Creating a Ryax workflow
• Triggers
  • API HTTP JSON
• Projects
• Sites
• Ryax versus other similar tools
  • Homemade tools
  • Airflow
  • Container orchestrators (Kubernetes, Mesos, Docker Swarm, etc).
  • Automation Tools (Zapier, IFTTT, etc).
• Use cases
  • Fintech domain and Companies Financial Analysis
  • Precision Medicine domain and Simulations-based applications
  • Data Analytics PoC and MVP
  • Creating API-first backends
  • Automate daily tasks
  • Data Industrialization
  • Lab Automation

Tutorials

• Deploy your first workflow-based application
  • Assembling our first workflow
  • Deploying and running our AI-based workflow
  • Checking executions
• Commit your own actions and use them in a workflow
  • Add and Scan Git repositories
• Workflow executions on multiple sites
  • Constraints: Configure an action to be executed on a particular site
  • Objectives: Configure an action to be scheduled by the Ryax scheduler
  • Inspection of multi-site workflow executions
• Actions and Triggers
  • General
  • Actions
  • Triggers
  • Migrating from v1 to v2.0
• Create C# Action
• Create NodeJS Action
• API Trigger
  • Part I - Build HTTP API JSON action
  • Part II - Create endpoint workflow
  • Conclusion and further reading
• Deploy a Jupyter-Notebook using the Serverless GPU feature
  • Dependencies and resources definition
  • Workflow creation and configuration
  • Workflow Deployment
  • Using the deployed Jupyter-Notebook service
  • Deploying the Jupyter-Notebook on an HPC cluster
• How to perform Sentiment Analysis on tweets
  • Birds-Eye View
  • Emit Gateway
  • Twitter Module
  • Sentiment Analysis
  • Publish to Google Sheet
• HPC Offloading
  • Requirements
  • Basic Usage
  • Advanced Usage for parallel job
  • HPC Actions repository

How-to guides

• Install Ryax on Kubernetes
  • Requirements
  • Preparatory Steps
  • Configure your Installation
  • Install Ryax
  • Configure your DNS
  • Access to your cluster
  • Cluster Update
  • Optimizing GPU compute resources with Nvidia’a Multi-instance GPUs (MIG)
• Enable Multi-Site on Ryax
  • SLURM_SSH Worker
  • Kubernetes Worker
• Ryax spark wrapped action
  • Requirements
  • Getting started
  • Advanced usage
  • Running on Ryax
• Backup Ryax with Velero
  • Prerequisites
  • Install

Reference

• Configure Ryax
  • Runner configuration
  • Studio configuration
  • Worker configuration
• Internal architecture
  • Overview
  • Interfaces of micro-services
  • Ryax code: our microservices
  • The external services
  • Tools and other
  • Infrastructure
• Glossary
• Public actions and triggers
  • Triggers
  • Actions
  • And more to come…