Skip to main content

A framework for building and running distributed, AI-powered data pipelines using Ray

Project description

Cosmos-xenna

Introduction

Cosmos-xenna is a Python library for building and running distributed data pipelines using Ray. It has a heavy focus on pipelines which are a series of inference steps using AI models. For example, a pipeline which downloads an image, runs a VLM on it to produce a caption, and then runs an embedding model to produce a text embedding and uploads the resulting data.

Cosmos-xenna simplifies the development of distributed AI pipelines by providing:

  • A simple interface
  • Autoscaling/autobalancing of stages
  • Stateful actors which allow the user to load/download weights before running processing
  • Independent allocation of NVDEC/NVENC hardware and "main" GPU compute

Installing

pip install cosmos-xenna[gpu]

Quick Start

For detailed examples, check out the examples/ directory.

Ray cluster requirements

Cosmos-xenna needs a few environment variables to be set before starting Ray clusters. These are set by Xenna when we start clusters locally, but if using an already existing cluster, they will need to be set in the processes initializing the cluster.

# Needed to give Xenna control over setting CUDA environment variables. Without this, Ray will overwrite the
# environment variables we set.
RAY_EXPERIMENTAL_NOSET_CUDA_VISIBLE_DEVICES="0"
# Needed to get debug info from as many actors as possible. By default, Ray only allows 10k
# actors to be listed. However, on large clusters, we may have more than 10k actors.
RAY_MAX_LIMIT_FROM_API_SERVER=40000
RAY_MAX_LIMIT_FROM_DATA_SOURCE=40000

Development

Setup development environment

We use UV for development. To get started, install UV, and run uv sync in this directory.

This will create a virtual environment at .venv based on the current lock file and will include all of the dependencies from core, dev, GPU, and examples.

Running commands

Use UV to run all commands. For example, to run the example pipeline, use:

uv run examples/simple_vlm_inference.py 

This will auto-sync dependencies if needed and execute the command in the UV-managed virtualenv.

VSCode integration

We provide recommended extensions and default settings for yotta via the .vscode/ folder. With these settings, VSCode should automatically format your code and raise linting/typing issues. VSCode will try to fix some minor linting issues on save.

Linting

We use Ruff and PyRight for static analysis. Using the default VSCode settings and recommended extensions, these should auto-run in VSCode. They can be run manually with:

uv run run_presubmit.py default

Adding dependencies

To add packages to the core dependencies, use uv add some-package-name

To add packages to dev use uv add --dev some-package-name

To add packages to other groups use uv add --group some-group some-package-name

License and Contact

This project will download and install additional third-party open source software projects. Review the license terms of these open source projects before use.

NVIDIA Cosmos source code is released under the Apache 2 License.

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

cosmos_xenna-0.1.2.tar.gz (299.9 kB view details)

Uploaded Source

Built Distribution

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

cosmos_xenna-0.1.2-py3-none-any.whl (185.8 kB view details)

Uploaded Python 3

File details

Details for the file cosmos_xenna-0.1.2.tar.gz.

File metadata

  • Download URL: cosmos_xenna-0.1.2.tar.gz
  • Upload date:
  • Size: 299.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for cosmos_xenna-0.1.2.tar.gz
Algorithm Hash digest
SHA256 7beac6fcb3bf771f3a72c1c3443460ee9ab22143962803374cf5b62b5d15d231
MD5 96cfc4bc4289cd3b67fb06e5d61a35ef
BLAKE2b-256 1c3f73cb722613efe4e3e97414b629d55aeb1f4abbacf9490b489242e990499f

See more details on using hashes here.

Provenance

The following attestation bundles were made for cosmos_xenna-0.1.2.tar.gz:

Publisher: release-from-tag.yml on nvidia-cosmos/cosmos-xenna

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cosmos_xenna-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: cosmos_xenna-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 185.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for cosmos_xenna-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e22565a5e8f5939a77e37a06d77bd3fa2301034e8c4749053fe9c97009b9b3b8
MD5 1dad2969b8456e766e4b63f6d3c9df96
BLAKE2b-256 a25f91ec927391ce6e2c72f54e63071f3cdbff7a0a169f982aaa4cb253dc8c5d

See more details on using hashes here.

Provenance

The following attestation bundles were made for cosmos_xenna-0.1.2-py3-none-any.whl:

Publisher: release-from-tag.yml on nvidia-cosmos/cosmos-xenna

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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