Skip to main content

Arena Platform Client Library and CLI.

Project description

agilerl-arena

agilerl-arena is the standalone Arena SDK + CLI package for AgileRL.

It provides:

  • Python client for Arena workflows (auth, environment validation, experiment submission, deployment, inference)
  • arena CLI for scripting and CI usage
  • Lightweight manifest validation models for Arena job manifests

This package is distributed independently from core agilerl, but exposes modules through the shared namespace:

from agilerl.arena import ArenaClient, Agent

Installation

Install directly:

pip install agilerl-arena

Or install through core AgileRL extras:

pip install "agilerl[arena]"

Quickstart

1) Authenticate

Preferred for CI/automation:

export ARENA_API_KEY="arena_pat_..."

Or interactive login:

arena login

2) Validate an environment

arena env validate --source path/to/my_env.py --name my-env

3) Submit a training manifest

arena experiments submit path/to/manifest.yaml --project my-project

Python SDK example

from agilerl.arena import ArenaClient

client = ArenaClient()  # uses ARENA_API_KEY if set

client.validate_environment(
    source="acrobot.py",
    name="acrobot-env",
)

result = client.submit_experiment(
    manifest="dqn.yaml",
    resource_id="arena-medium",
    project="my-project",
)

print(result)

Inference example

from agilerl.arena import Agent

agent = Agent("https://<deployment-id>.inference.agilerl.com", api_key="arena_pat_...")
action, _ = agent.get_action(observation)

Notes on packaging and imports

  • Distribution name: agilerl-arena
  • Python import namespace: agilerl.arena
  • CLI command: arena

agilerl-arena and agilerl intentionally share the agilerl.* namespace as separate packages.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agilerl_arena-0.1.0.dev0.tar.gz (125.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

agilerl_arena-0.1.0.dev0-py3-none-any.whl (100.0 kB view details)

Uploaded Python 3

File details

Details for the file agilerl_arena-0.1.0.dev0.tar.gz.

File metadata

  • Download URL: agilerl_arena-0.1.0.dev0.tar.gz
  • Upload date:
  • Size: 125.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.8

File hashes

Hashes for agilerl_arena-0.1.0.dev0.tar.gz
Algorithm Hash digest
SHA256 4618066337374196ae985d53988a5131c043010350d69af7daa9ccfc0974f8ed
MD5 35be4570e27786f35c37f4859dc9fba5
BLAKE2b-256 f92ac3238d646dab4ed613646e394c6c97b22f614d42292c7eb432f1845d473a

See more details on using hashes here.

File details

Details for the file agilerl_arena-0.1.0.dev0-py3-none-any.whl.

File metadata

File hashes

Hashes for agilerl_arena-0.1.0.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 35541a82684a0af252de2bc747360bb26d890ba4d1a254dbe50c4d0feaa628aa
MD5 409ca435cb2da5fb02f77216d30e57f6
BLAKE2b-256 5081d994952c547b38350152b7e1b34ee474b2bb5f9b32c0ce969e8d6d732a11

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page