Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
luccabb committed Jan 25, 2025
1 parent 2c32a6c commit a7b858e
Showing 1 changed file with 28 additions and 12 deletions.
40 changes: 28 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,34 @@

GPU Node ID (GNI) is a rust based library for creating an identifier for the set of GPUs running on the host. The ID is generated by hashing (blake3) all GPU UUIDs sorted lexicographically. GNI provides a consistent implementation for calculating and retrieving the ID, with bindings to a set of languages (Python, Go, C, CPP) to ensure a consistent and startardized approach to using this ID.

## Rust Build and Running GNI
## Multi-Language Support

GNI offers the same core functionality for each supported language, provides bindings, and you can build from source for:

- [c](/src/c/README.md)
- [cpp](/src/cpp/README.md)
- [go](/src/go/README.md)
- [python](/src/python/README.md)
- [rust](./README.md): see below

> Note: If you’d like support for another language, please open an issue or submit a pull request!
## Rust Library

GNI is available on [crates.io](), you should be able to call it from your Rust code:
```
let result = gni_lib::get_gpu_node_id(None);
println!("Result: {:?}", result);
```

Cargo.toml
```
...
[dependencies]
gni = "0.1.0"
```

## Rust Build and Running GNI from source

### Prerequisites

Expand Down Expand Up @@ -32,17 +59,6 @@ Options:
-V, --version Print version
```

## Non Rust usage

GNI offers the same core functionality for each supported language, provides bindings, and you can build from source for:

- [c](/src/c/README.md)
- [cpp](/src/cpp/README.md)
- [go](/src/go/README.md)
- [python](/src/python/README.md)

> Note: If you’d like support for another language, please open an issue or submit a pull request!
## Contributing

Read our contributing guide to learn about our development process, how to propose bugfixes and feature requests, and how to build your changes.
Expand Down

0 comments on commit a7b858e

Please sign in to comment.