Skip to content

Commit

Permalink
[PJRT] Update README to align with the current status (iree-org#19457)
Browse files Browse the repository at this point in the history
Some content in the README of PJRT plugin is outdated, so in this PR I
try to update them.

Since it is difficult for me to decide some of the content directly,
there will be some comments below to solicit people's suggestions : )

---------

Signed-off-by: PragmaTwice <[email protected]>
  • Loading branch information
PragmaTwice authored Dec 12, 2024
1 parent 7e1804b commit 900ef1d
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions integrations/pjrt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,11 @@ most powerful).

## Install a compatible version of Jax and the IREE compiler

```
```shell
pip install -r requirements.txt

# Assume that you have the Jax repo checked out at JAX_REPO from
# https://github.com/google/jax (must be paired with nightly jaxlib).
pip install -e $JAX_REPO
# a higher version of jax is highly recommended, e.g. 0.4.36
pip install jax==0.4.36
```

Verify that your Jax install is functional like:
Expand Down Expand Up @@ -78,14 +77,17 @@ The plugin `openxla_pjrt_artifacts` is in the `ctstools` directory and
performs additional manipulation of the environment in order to save
compilation artifacts, reproducers, etc.

## Contacts
## Communication channels

* [GitHub issues](https://github.com/openxla/openxla-pjrt-plugin/issues):
Feature requests, bugs, and other work tracking
* [OpenXLA discord](https://discord.gg/pvuUmVQa): Daily development discussions
with the core team and collaborators
* Please submit feature requests and bug reports about the plugin in [GitHub Issues](https://github.com/iree-org/iree/issues).
* Discuss the development of the plugin at `#jax` or `#pjrt-plugin` channel of [IREE Discord server](https://discord.gg/wEWh6Z9nMU).
* Check the [OpenXLA/XLA](https://github.com/openxla/xla) repo and [its communication channels](https://github.com/openxla/community?tab=readme-ov-file#communication-channels) for PJRT APIs and clients.

## License

OpenXLA PJRT plugin is licensed under the terms of the Apache 2.0 License with
LLVM Exceptions. See [LICENSE](LICENSE) for more information.
IREE PJRT plugin is licensed under the terms of the Apache 2.0 License with
LLVM Exceptions. See [LICENSE](../../LICENSE) for more information.

[PJRT C API](./third_party/pjrt_c_api) comes from
[OpenXLA/XLA](https://github.com/openxla/xla) and is licensed under
the Apache 2.0 License. See its own [LICENSE](./third_party/pjrt_c_api/LICENSE) for more information.

0 comments on commit 900ef1d

Please sign in to comment.