From 47d3a64e8b125170d1290138c1dee4709b9d8132 Mon Sep 17 00:00:00 2001 From: Daniel Gafni Date: Fri, 19 Apr 2024 19:11:10 +0200 Subject: [PATCH] :docs: add installation instructions to README.md (#8) --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a56aa91..b70b1e7 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,15 @@ # `dagster-ray` - [![image](https://img.shields.io/pypi/v/dagster-ray.svg)](https://pypi.python.org/pypi/dagster-ray) [![image](https://img.shields.io/pypi/l/dagster-ray.svg)](https://pypi.python.org/pypi/dagster-ray) [![image](https://img.shields.io/pypi/pyversions/dagster-ray.svg)](https://pypi.python.org/pypi/dagster-ray) -[![CI](https://github.com/danielgafni/dagster-ray/actions/workflows/ci.yml/badge.svg)](https://github.com/danielgafni/dagster-ray/actions/workflows/CI.yml) +[![CI](https://github.com/danielgafni/dagster-ray/actions/workflows/CI.yml/badge.svg)](https://github.com/danielgafni/dagster-ray/actions/workflows/CI.yml) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) [![Checked with pyright](https://microsoft.github.io/pyright/img/pyright_badge.svg)](https://microsoft.github.io/pyright/) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) +--- + [Ray](https://github.com/ray-project/ray) integration library for [Dagster](https://github.com/dagster-io/dagster). `dagster-ray` allows running Ray computations in Dagster pipelines. It provides various Dagster abstractions, the most important being `Resource`, and helper `@op`s and `@schedule`s, for multiple backends. @@ -26,6 +27,18 @@ Documentation can be found below. > [!NOTE] > This project is in early development. Contributions are very welcome! See the [Development](#development) section below. +# Installation + +```shell +pip install dagster-ray +``` + +To install with extra dependencies for a particular backend (like `kuberay`), run: + +```shell +pip install 'dagster-ray[kuberay]' +``` + # Backends `dagster-ray` provides a `RayResource` class, which does not implement any specific backend.