Skip to content

Commit ac7f06f

Browse files
committed
Initial placeholder README.md file
1 parent fc92e2f commit ac7f06f

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# ray-pipeline
2+
3+
*Part of the CodeFlare project.*
4+
5+
The `ray-pipeline` library provides facilities for defining and running parallel pipelines on top of [Ray](https://ray.io). The goal of this project is to unify pipeline workflows across multiple platforms such as [scikit-learn](https://scikit-learn.org/) and [Apache Spark](https://spark.apache.org/), while providing nearly optimal scale-out parallelism on pipelined computations.
6+
7+
## Release status
8+
9+
This project is under active development. Keep an eye on this page for our first public release!
10+
11+
See the [design document](https://docs.google.com/document/d/1t1K8N07TcbBKBgrcI6jf9tPow00cOKE9whnEVxOd4-U/edit) for more information on our design goals.
12+
13+
## Example notebooks
14+
15+
**TODO:** Add instructions for running the notebooks in the `notebooks` directory.
16+
17+
## Building
18+
19+
**TODO:** Add instructions for building from source once `setup.py` has been cleaned up.
20+
21+
## Contributing
22+
23+
**TODO:** Create a `CONTRIBUTING.md` file and add high-level instructions here
24+
25+
## Running tests
26+
27+
TODO: Fill out this sectionce we have

0 commit comments

Comments
 (0)