Skip to content

Commit

Permalink
Update readme to have a getting started section (#777)
Browse files Browse the repository at this point in the history
* Readme updated

* Readme updated

* Updated

* changelog

* Meeting link updated

* updated

* Update README.md

Co-authored-by: Haytham Abuelfutuh <[email protected]>

* Update rsts/community/index.rst

Co-authored-by: Haytham Abuelfutuh <[email protected]>

Co-authored-by: Haytham Abuelfutuh <[email protected]>
Signed-off-by: Haytham Abuelfutuh <[email protected]>
  • Loading branch information
kumare3 and EngHabu committed Apr 30, 2021
1 parent ba7b78f commit 32a594b
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 22 deletions.
63 changes: 42 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,19 @@
![Twitter Follow](https://img.shields.io/twitter/follow/flyteorg?label=Follow&style=social)
[![Slack Status](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://forms.gle/UVuek9WfBoweiqcJA)

Flyte is a container-native, type-safe workflow and pipelines platform optimized for large scale processing and machine learning written in Golang. Workflows can be written in any language, with out of the box support for Python, Java and Scala.
Flyte is a production-grade, container-native, type-safe workflow and pipelines platform optimized for large scale processing and machine learning written in Golang. Workflows can be written in any language, with out of the box support for [Python](https://github.com/flyteorg/flytekit), [Java and Scala](https://github.com/spotify/flytekit-java).

# Homepage
- [flyte.org](https://flyte.org)
- [Docs](https://flyte.readthedocs.io/en/latest/)
---

[HomePage](https://flyte.org) |
[Quickstart](#quickstart) |
[Documentation](https://docs.flyte.org/) |
[Features](#features) |
[Community & Resources](#community--resources) |
[Changelogs](CHANGELOG/) |
[Components](#component-repos)

---

# Introduction
Flyte is a fabric that connects disparate computation backends using a type safe data dependency graph. It records all changes to a pipeline, making it possible to rewind time. It also stores
Expand All @@ -25,15 +33,30 @@ Flyte is more than a workflow engine, it provides workflows as a core concepts,
producer-consumer order creates a workflow. Flyte workflows are pure specification and can be created using any language. Every task can also by any language. We do provide first class support for
python, making it perfect for modern Machine Learning and Data processing pipelines.

# Resources
# QuickStart
With [docker installed](https://docs.docker.com/get-docker/), run this command:

```bash
docker run --rm --privileged -p 30081:30081 -p 30084:30084 ghcr.io/flyteorg/flyte-sandbox
```

This creates a local Flyte sandbox. Once the sandbox is ready, you should see the following message: ``Flyte is ready! Flyte UI is available at http://localhost:30081/console``. Go ahead and visit http://localhost:30081/console.
A quick visual tour of the console

![Flyte console Example](https://github.com/flyteorg/flyte/raw/static-resources/img/first-run-console-2.gif)

Refer to [Docs - Getting Started](https://docs.flyte.org/en/latest/index.html) for complete end to end example.

# Community & Resources
Resources that would help you get a better understanding of Flyte.

# Communication channels
## Communication channels
- [Slack Org](https://forms.gle/UVuek9WfBoweiqcJA)
- [Email list](https://groups.google.com/a/flyte.org/g/users)

# Biweekly Community Sync
- Starting April 21 2020, the Flyte community meets every other Tuesday at 9:00 AM PST (US West coast time).
## Biweekly Community Sync
- 📣  Flyte OSS Community Sync Every alternate Tuesday, 9am-10am PDT ([Checkout the events calendar & subscribe](https://calendar.google.com/calendar/embed?src=admin%40flyte.org&ctz=America%2FLos_Angeles)

- You can join the [zoom link]( https://us04web.zoom.us/j/71298741279?pwd=TDR1RUppQmxGaDRFdzBOa2lHN1dsZz09).
- Meeting notes are captured in [Doc](https://docs.google.com/document/d/1Jb6eOPOzvTaHjtPEVy7OR2O5qK1MhEs3vv56DX2dacM/edit#heading=h.c5ha25xc546e)
- Demo Signup [Sheet](https://docs.google.com/spreadsheets/d/1Bz-s3SpMm1hGl6Z5y3HcxrNBcg9ZhSgqVgmCxK_eEhs/edit#gid=0)
Expand Down Expand Up @@ -93,30 +116,33 @@ Resources that would help you get a better understanding of Flyte.
- Snappy Console
- Python CLI
- Written in Golang and optimized for performance of large running jobs

## In Progress
- Golang CLI - flytectl

## Coming Soon
- Reactive pipelines
## Inprogress
- Grafana templates (user/system observability)
- More integrations

- helm chart for Flyte
- Performance optimization
- Flink-K8s

# Available Plugins
- Containers
- K8s Pods
- AWS Batch Arrays
- K8s Pod arrays
- K8s Spark (native pyspark and java/scala)
- AWS Athena
- Qubole Hive
- Presto Queries
- Distributed Pytorch (K8s Native) - Pytorch Operator
- Sagemaker (builtin algorithms & custom models)
- Distributed Tensorflow (K8s Native) - TFOperator
- Papermill Notebook execution (python and spark)
- Type safe and data checking for Pandas dataframe using Pandera

## Coming Soon
- Reactive pipelines
- More integrations

## Coming soon
- Flink-K8s

# Current Usage
- [Freenome](https://www.freenome.com/)
Expand All @@ -125,10 +151,6 @@ Resources that would help you get a better understanding of Flyte.
- [Spotify](https://www.spotify.com/)
- [USU Group](https://www.usu.com/)

# Changelogs
[Changelogs](CHANGELOG/README.md)


# Component Repos
Repo | Language | Purpose | Status
--- | --- | --- | ---
Expand Down Expand Up @@ -185,4 +207,3 @@ Thank you to the community for making Flyte possible.
- [@catalinii](https://github.com/catalinii)
- [@kumare3](https://github.com/kumare3)


2 changes: 1 addition & 1 deletion rsts/community/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ so please join us on the
- `Slack <http://flyte-org.slack.com>`_
- `Email <https://groups.google.com/a/flyte.org/d/forum/users>`_
- `Twitter <https://twitter.com/flyteorg>`_
- Community Sync every other Tuesday, 9:00 AM PDT/PST please check out the `calendar <https://calendar.google.com/calendar/embed?src=admin%40flyte.org&ctz=America%2FLos_Angeles>`_

We love contributions, so please contribute to
- docs
- examples
- new plugins or plugin ideas
- just feedback in general

0 comments on commit 32a594b

Please sign in to comment.