Skip to content

Quickstart

Installation

curl -LsSf https://astral.sh/uv/install.sh | sh   # Install uv (if needed)
git clone https://github.com/roger-creus/agentick.git
cd agentick
uv sync --extra all                                  # All dependencies

Install only what you need:

uv sync                     # Core only
uv sync --extra rl          # RL training (torch, stable-baselines3)
uv sync --extra llm         # LLM agents (openai, transformers)
uv sync --extra vllm        # vLLM serving
uv sync --extra finetune    # Fine-tuning (trl, peft)
uv sync --extra viz         # Visualization (matplotlib)
uv sync --extra tracking    # Experiment tracking (wandb)
uv sync --extra webapp      # Human play webapp (flask)
uv sync --extra all         # Everything

Basic Usage

import agentick

env = agentick.make("GoToGoal-v0", difficulty="easy")
obs, info = env.reset(seed=42)

for step in range(100):
    action = env.action_space.sample()
    obs, reward, terminated, truncated, info = env.step(action)
    if terminated or truncated:
        break
env.close()

Observation Modes

env = agentick.make("GoToGoal-v0", render_mode="ascii")           # Text grid
env = agentick.make("GoToGoal-v0", render_mode="language")         # Natural language
env = agentick.make("GoToGoal-v0", render_mode="rgb_array")        # Isometric pixels (512x512)
env = agentick.make("GoToGoal-v0", render_mode="state_dict")       # Full state dict

Difficulty Levels

env = agentick.make("GoToGoal-v0", difficulty="easy")    # 5x5 grid
env = agentick.make("GoToGoal-v0", difficulty="medium")  # 10x10 grid
env = agentick.make("GoToGoal-v0", difficulty="hard")    # 15x15 grid
env = agentick.make("GoToGoal-v0", difficulty="expert")  # 20x20 grid

Reward Modes

env = agentick.make("GoToGoal-v0", reward_mode="sparse")  # +1 at goal only
env = agentick.make("GoToGoal-v0", reward_mode="dense")   # Shaped progress reward

List Tasks

from agentick.tasks.registry import list_tasks
tasks = list_tasks()                          # All registered tasks
nav_tasks = list_tasks(capability="navigation")

uv run agentick list-tasks
uv run agentick list-suites

Next Steps