add-workflow

Add a RolloutWorkflow to the AReaL codebase with registration and tests.

5.7k|573|Updated Feb 24, 2025
One-click install
npx skills add https://github.com/inclusionAI/AReaL --skill add-workflow
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: add-workflow
Source: https://github.com/inclusionAI/AReaL/tree/main/.claude/skills/add-workflow
Command: npx skills add https://github.com/inclusionAI/AReaL --skill add-workflow

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill provides a clear, repeatable blueprint for adding a new RolloutWorkflow to the AReaL codebase, reducing manual setup time and human error when extending orchestrations.

Core Features & Use Cases

  • Workflow Template: A ready-to-use template for implementing a RolloutWorkflow with proper async methods and registration.
  • Registration Guide: Step-by-step instructions to expose the new workflow via init.py and trainer configuration.
  • Validation & Testing: Guidance to add tests ensuring async behavior, correct tensor shapes, and integration with the training loop.

Quick Start

Create the file areal/workflow/<name>.py implementing a RolloutWorkflow, register it, and point the trainer to the new workflow. Then run the test suite to validate.

Frequently Asked Questions about add-workflow

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add a new rollout workflow to the AReaL codebase?

To add a new rollout workflow to AReaL, create the workflow file in areal/workflow/, implement async methods, register it via __init__.py, update trainer configuration, and add validation tests for integration.

What do I need to register a custom RolloutWorkflow in Python?

Registering a custom RolloutWorkflow requires exposing the new class through __init__.py and pointing the trainer configuration to the workflow file, ensuring proper imports and async operation are maintained.

How do I test async rollout workflows for correct tensor shapes?

Testing async rollout workflows involves adding test scaffolding that validates async behavior, checks correct tensor shapes, and verifies integration with the training loop to ensure proper orchestration execution.

Can I extend AReaL orchestration without modifying existing trainers?

Extending AReaL orchestration requires updating trainer configuration to point to the new workflow file, meaning existing trainers must be adjusted to recognize and execute the newly registered RolloutWorkflow.

Why does my AReaL workflow registration fail when adding a new rollout?

AReaL workflow registration fails when the workflow file lacks proper async implementation, missing __init__.py exposure, or incomplete trainer configuration updates needed to expose the new RolloutWorkflow correctly.

What is a RolloutWorkflow template in AReaL?

A RolloutWorkflow template in AReaL is a repeatable blueprint providing ready-to-use async method structures and registration steps, reducing manual setup time and human error when extending orchestrations.