Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/tag-release-image.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
workflow_dispatch:
inputs:
tag:
description: 'Release tag to build (e.g., v0.5.1)'
description: 'Release tag to build (e.g., v0.5.2)'
required: true
type: string

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test-areal.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ env:
RUNNER_LABELS: gcp-a2-highgpu-2g
RUNNER_VERSION: '2.317.0'
GCP_OS_IMAGE: areal-cicd-test-202512290
CONTAINER_IMAGE: ghcr.io/inclusionai/areal-runtime:${{ (github.head_ref == 'build-docker-image' || github.ref_name == 'build-docker-image') && 'dev' || 'v0.5.1' }}
CONTAINER_IMAGE: ghcr.io/inclusionai/areal-runtime:${{ (github.head_ref == 'build-docker-image' || github.ref_name == 'build-docker-image') && 'dev' || 'v0.5.2' }}

jobs:
provision-runner:
Expand Down
2 changes: 1 addition & 1 deletion areal/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

class VersionInfo:
def __init__(self):
self.__version__ = "0.5.1"
self.__version__ = "0.5.2"
self.__branch__ = ""
self.__commit__ = ""
self.__is_dirty__ = False
Expand Down
6 changes: 3 additions & 3 deletions docs/tutorial/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The following hardware configuration has been extensively tested:
| Git LFS | Required for downloading models, datasets, and AReaL code. See [installation guide](https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage) |
| Docker | 27.5.1 |
| NVIDIA Container Toolkit | See [installation guide](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html) |
| AReaL Image | `ghcr.io/inclusionai/areal-runtime:v0.5.1` (includes runtime dependencies and Ray components) |
| AReaL Image | `ghcr.io/inclusionai/areal-runtime:v0.5.2` (includes runtime dependencies and Ray components) |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

While this update is correct, hardcoding the version string in multiple places across documentation and example files makes the project harder to maintain. Each version bump requires manually finding and replacing all occurrences, which is error-prone. As suggested in the general feedback, centralizing this version string would be a significant improvement for future releases.


**Note**: This tutorial does not cover the installation of NVIDIA Drivers, CUDA, or
shared storage mounting, as these depend on your specific node configuration and system
Expand All @@ -42,11 +42,11 @@ We recommend using Docker with our provided image. The Dockerfile is available i
top-level directory of the AReaL repository.

```bash
docker pull ghcr.io/inclusionai/areal-runtime:v0.5.1
docker pull ghcr.io/inclusionai/areal-runtime:v0.5.2
docker run -it --name areal-node1 \
--privileged --gpus all --network host \
--shm-size 700g -v /path/to/mount:/path/to/mount \
ghcr.io/inclusionai/areal-runtime:v0.5.1 \
ghcr.io/inclusionai/areal-runtime:v0.5.2 \
/bin/bash
git clone https://github.com/inclusionAI/AReaL
cd AReaL
Expand Down
4 changes: 2 additions & 2 deletions examples/skypilot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ resources:
cpus: 8+
memory: 32GB+
disk_size: 256GB
image_id: docker:ghcr.io/inclusionai/areal-runtime:v0.5.1
image_id: docker:ghcr.io/inclusionai/areal-runtime:v0.5.2

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The version string is also hardcoded here. For YAML examples like this, consider using environment variables if the execution environment (like SkyPilot) supports it. This would allow setting the version in one place for all examples.


num_nodes: 1

Expand Down Expand Up @@ -76,7 +76,7 @@ Specify the resources and image used to run the experiment.
```yaml
resources:
accelerators: A100:8
image_id: docker:ghcr.io/inclusionai/areal-runtime:v0.5.1
image_id: docker:ghcr.io/inclusionai/areal-runtime:v0.5.2
memory: 256+
cpus: 32+

Expand Down
2 changes: 1 addition & 1 deletion examples/skypilot/ray_cluster.sky.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

resources:
accelerators: A100:8
image_id: docker:ghcr.io/inclusionai/areal-runtime:v0.5.1
image_id: docker:ghcr.io/inclusionai/areal-runtime:v0.5.2
memory: 32+
cpus: 8+

Expand Down
2 changes: 1 addition & 1 deletion examples/skypilot/single_node.sky.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ resources:
cpus: 8+
memory: 32GB+
disk_size: 256GB
image_id: docker:ghcr.io/inclusionai/areal-runtime:v0.5.1
image_id: docker:ghcr.io/inclusionai/areal-runtime:v0.5.2

num_nodes: 1

Expand Down