Skip to content

[pull] main from inclusionAI:main #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pull merged 2 commits into from
Apr 2, 2026
Merged

[pull] main from inclusionAI:main #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a0f378f
chore: fix gcp image (#1130)
nuzant Apr 2, 2026
e73b092
docs: add Trackio configuration to CLI reference (#1131)
rchardx Apr 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/test-areal.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ concurrency:
env:
GCP_PROJECT_ID: ${{ secrets.GCP_PROJECT_ID }}
RUNNER_VERSION: '2.332.0'
GCP_OS_IMAGE: areal-cicd-test-20260330-386
GCP_OS_IMAGE: areal-cicd-test-20260401-387

jobs:
determine-variants:
Expand Down
39 changes: 31 additions & 8 deletions docs/en/cli_reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ For detailed examples, see the experiment configurations in the `examples/` dire
- [StatsLogger Configuration](section-stats-logger)
- [Swanlab Configuration](section-swanlab)
- [TensorBoard Configuration](section-tensor-board)
- [Trackio Configuration](section-trackio)
- [WandB Configuration](section-wand-b)

### Others
Expand Down Expand Up @@ -742,14 +743,15 @@ Configuration for model checkpoint saving scheduling and timing.

Configuration for experiment statistics logging and tracking services.

| Parameter | Type | Default | Description |
| ----------------- | ------------------------------------------- | ------------ | ------------------------------------------------------ |
| `experiment_name` | string | **Required** | - |
| `trial_name` | string | **Required** | - |
| `fileroot` | string | **Required** | - |
| `wandb` | [`WandBConfig`](section-wand-b) | **Required** | Weights & Biases configuration. |
| `swanlab` | [`SwanlabConfig`](section-swanlab) | **Required** | SwanLab configuration. |
| `tensorboard` | [`TensorBoardConfig`](section-tensor-board) | **Required** | TensorBoard configuration. Only 'path' field required. |
| Parameter | Type | Default | Description |
| ----------------- | ------------------------------------------- | ------------ | --------------------------------------------------------- |
| `experiment_name` | string | **Required** | - |
| `trial_name` | string | **Required** | - |
| `fileroot` | string | **Required** | - |
| `wandb` | [`WandBConfig`](section-wand-b) | **Required** | Weights & Biases configuration. |
| `swanlab` | [`SwanlabConfig`](section-swanlab) | **Required** | SwanLab configuration. |
| `tensorboard` | [`TensorBoardConfig`](section-tensor-board) | **Required** | TensorBoard configuration. Only 'path' field required. |
| `trackio` | [`TrackioConfig`](section-trackio) | **Required** | Trackio configuration (Hugging Face experiment tracking). |

(section-swanlab)=

Expand All @@ -776,6 +778,27 @@ Configuration for TensorBoard logging and visualization.
| --------- | -------------- | ------- | ----------- |
| `path` | string \| None | `None` | - |

(section-trackio)=

## Trackio Configuration

Configuration for Trackio experiment tracking (Hugging Face).

Trackio is a lightweight, local-first experiment tracking library with a
wandb-compatible API. Dashboards can be viewed locally or deployed to Hugging Face
Spaces.

```
See: https://github.com/gradio-app/trackio
```

| Parameter | Type | Default | Description |
| ---------- | -------------- | ------------ | ----------- |
| `mode` | string | `"disabled"` | - |
| `project` | string \| None | `None` | - |
| `name` | string \| None | `None` | - |
| `space_id` | string \| None | `None` | - |

(section-wand-b)=

## WandB Configuration
Expand Down
39 changes: 31 additions & 8 deletions docs/zh/cli_reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ python3 train.py --config path/to/config.yaml actor.lr=1e-4 seed=42
- [StatsLogger Configuration](section-stats-logger)
- [Swanlab Configuration](section-swanlab)
- [TensorBoard Configuration](section-tensor-board)
- [Trackio Configuration](section-trackio)
- [WandB Configuration](section-wand-b)

### Others
Expand Down Expand Up @@ -740,14 +741,15 @@ Configuration for model checkpoint saving scheduling and timing.

Configuration for experiment statistics logging and tracking services.

| Parameter | Type | Default | Description |
| ----------------- | ------------------------------------------- | ------------ | ------------------------------------------------------ |
| `experiment_name` | string | **Required** | - |
| `trial_name` | string | **Required** | - |
| `fileroot` | string | **Required** | - |
| `wandb` | [`WandBConfig`](section-wand-b) | **Required** | Weights & Biases configuration. |
| `swanlab` | [`SwanlabConfig`](section-swanlab) | **Required** | SwanLab configuration. |
| `tensorboard` | [`TensorBoardConfig`](section-tensor-board) | **Required** | TensorBoard configuration. Only 'path' field required. |
| Parameter | Type | Default | Description |
| ----------------- | ------------------------------------------- | ------------ | --------------------------------------------------------- |
| `experiment_name` | string | **Required** | - |
| `trial_name` | string | **Required** | - |
| `fileroot` | string | **Required** | - |
| `wandb` | [`WandBConfig`](section-wand-b) | **Required** | Weights & Biases configuration. |
| `swanlab` | [`SwanlabConfig`](section-swanlab) | **Required** | SwanLab configuration. |
| `tensorboard` | [`TensorBoardConfig`](section-tensor-board) | **Required** | TensorBoard configuration. Only 'path' field required. |
| `trackio` | [`TrackioConfig`](section-trackio) | **Required** | Trackio configuration (Hugging Face experiment tracking). |

(section-swanlab)=

Expand All @@ -774,6 +776,27 @@ Configuration for TensorBoard logging and visualization.
| --------- | -------------- | ------- | ----------- |
| `path` | string \| None | `None` | - |

(section-trackio)=

## Trackio Configuration

Configuration for Trackio experiment tracking (Hugging Face).

Trackio is a lightweight, local-first experiment tracking library with a
wandb-compatible API. Dashboards can be viewed locally or deployed to Hugging Face
Spaces.

```
See: https://github.com/gradio-app/trackio
```

| Parameter | Type | Default | Description |
| ---------- | -------------- | ------------ | ----------- |
| `mode` | string | `"disabled"` | - |
| `project` | string \| None | `None` | - |
| `name` | string \| None | `None` | - |
| `space_id` | string \| None | `None` | - |

(section-wand-b)=

## WandB Configuration
Expand Down
Loading