ray-dashboard-sdk 0.4.0

A simple Rust client for the Ray Dashboard REST API.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

# ray-dashboard-sdk

A simple Rust client for the [Ray]( https://docs.ray.io/en/latest/index.html#) Dashboard REST API.

[![Crates.io][crates-badge]][crates-url]
[![MIT licensed][mit-badge]][mit-url]
[![Build Status][actions-badge]][actions-url]

[crates-badge]: https://img.shields.io/crates/v/ray-dashboard-sdk.svg
[crates-url]: https://crates.io/crates/ray-dashboard-sdk
[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
[mit-url]: https://github.com/sfriedowitz/ray-dashboard-sdk/blob/main/LICENSE
[actions-badge]: https://github.com/sfriedowitz/ray-dashboard-sdk/workflows/CI/badge.svg
[actions-url]: https://github.com/sfriedowitz/ray-dashboard-sdk/actions/workflows/ci.yml

> [!WARNING]
> This project is experimental and under active development. The API is unstable and subject to breaking changes. It is **not production ready** — use at your own risk.

## Overview

A Rust SDK for the Ray Dashboard REST API. 

Currently supports the Jobs API for submitting and managing Ray jobs.

See [examples/](examples/) for usage examples.

## Contributing

### Running Tests

Integration tests require a running Ray cluster:

```bash
# Start Ray cluster
docker compose up -d

# Run tests
cargo test

# Stop Ray cluster
docker compose down
```

### Running Examples

Examples also require the Ray cluster:

```bash
docker compose up -d
cargo run --example simple
cargo run --example axum
```

## TODO

- Expand unit tests for schemas
- Implement Serve API bindings