Skip to content

Commit 0408629

Browse files
chcostGitHub Enterprise
chcost
authored and
GitHub Enterprise
committed
Merge pull request #19 from codeflare/main
2 parents 5115ddf + 0bfcf59 commit 0408629

File tree

4 files changed

+231
-0
lines changed

4 files changed

+231
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/user-story.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
name: User story
3+
about: User stories
4+
title: ''
5+
labels: ''
6+
assignees: chcost, msrivats, rganti
7+
8+
---
9+
10+
## Overview
11+
12+
<!--
13+
Describe the goal or feature or two, usually in the form of a user story.
14+
As a [USER], I want to [TASK], so that [REASON]
15+
-->
16+
17+
### Acceptance Criteria
18+
19+
<!-- Ask yourself, are these criteria testable?
20+
21+
- [ ] List of what needs to be true
22+
- [ ] to consider this done
23+
- [ ] done done
24+
-->
25+
26+
### Questions
27+
28+
<!--
29+
- List any questions?
30+
- That you are unsure of the answer?
31+
-->
32+
33+
### Assumptions
34+
35+
<!--
36+
- List any assumptions that
37+
- You are making in terms of time-frame,
38+
- Output, or general context setting
39+
-->
40+
41+
### Reference
42+
43+
<!--
44+
- [Reference](links)
45+
- [To issues](or-any-inspiration)
46+
- [That might be](helpful)
47+
-->

‎README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<p align="center">
2+
<img src="./images/pipelines.svg" width="340" height="207">
3+
</p>
4+
5+
6+
# Pipelines
7+
8+
The `CodeFlare-Pipelines` 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.
9+
10+
## Release status
11+
12+
This project is under active development. Keep an eye on this page for our first public release!
13+
14+
See the [design document](https://docs.google.com/document/d/1t1K8N07TcbBKBgrcI6jf9tPow00cOKE9whnEVxOd4-U/edit) for more information on our design goals.
15+
16+
## Example notebooks
17+
18+
**TODO:** Add instructions for running the notebooks in the `notebooks` directory.
19+
20+
## Building
21+
22+
**TODO:** Add instructions for building from source once `setup.py` has been cleaned up.
23+
24+
## Contributing
25+
26+
**TODO:** Create a `CONTRIBUTING.md` file and add high-level instructions here
27+
28+
## Running tests
29+
30+
TODO: Fill out this sectionce we have

‎images/pipelines.svg

Lines changed: 116 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)