From f139b56f8537f3b77c2aa12a585be9cc7e7f6070 Mon Sep 17 00:00:00 2001 From: Samhita Alla Date: Fri, 7 May 2021 22:08:36 +0530 Subject: [PATCH] Update README (#199) --- README.md | 62 +++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 49 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 820e3fd3cf..2a3ac69c87 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,56 @@ -# flytesnacks: Deep Dive into Flyte + +

+ Flyte Logo +

+

+ Flyte User Guide & Tutorials +

+

+ Flytesnacks encompasses code examples built on top of Flytekit Python +

+

+ User Guide + ยท + Tutorials + ยท + Contribution Guide +

+ -## Goal -Create a single repository that will provide useful snippets, examples and demos for using Flyte. + +

+ ๐Ÿš€ Quick Start +

+ -## Pre-Requiste -First time users: refer to [flyte.org](https://flyte.org) for a Flyte orientation (highly recommended). +> To get the hang of Python SDK, refer to the [Getting Started](https://docs.flyte.org/en/latest/getting_started.html) tutorial before exploring the examples. -To start using Flyte, go to the [Getting started guide](https://docs.flyte.org/en/latest/getting_started.html). +[User Guide](https://docs.flyte.org/projects/cookbook/en/latest/index.html) section has code examples, tips, and tricks that showcase the usage of Flyte features and integrations. -After Getting Started, use this repository for a deeper dive. +[Tutorials](https://docs.flyte.org/projects/cookbook/en/latest/tutorials.html) section has real-world examples, ranging from machine learning training, data processing to feature engineering. -# Index -1. [Simple Examples using Flytekit Python](./python) -2. [Cookbook for recipes to leverage various features of Flytekit Python](./cookbook) -3. [Examples of using Flyte Plugins in Flytekit Python](./plugins) -4. [Jupyter Notebook Examples](./notebooks) -5. [Past Demos examples](./demos) + +

+ ๐Ÿ“– Contribution Guide +

+ +Flytesnacks currently has all examples in Python (Flytekit Python SDK). In the future, Java examples employing Flytekit JAVA will be out. +Here are the setup instructions to start contributing to `flytesnacks` repo: +- If the Python code has to be tested, run it locally +- If the Python code has to be tested in a cluster: + * Run the `make start` command in the root directory of the flytesnacks repo + * Visit https://localhost:30081 to view the Flyte console consisting of the examples present in flytesnacks/cookbook/core directory + * To fetch new dependencies and rebuild the image, run `make register` + * If examples from a different directory (other than `core`) have to registered, run the command `SANDBOX=1 make -C register` in the `flytesnacks` repo. + +`docs` folder in `flytesnacks` houses the user guide and tutorials present in the documentation. Refer to the [documentation contribution guide](https://docs.flyte.org/en/latest/community/contribute.html#documentation) to get acquainted with the guidelines. + + +

+ ๐Ÿž File an Issue +

+ + +Refer to the [issues](https://docs.flyte.org/en/latest/community/contribute.html#issues) section in the contribution guide if you'd like to file an issue relating to `flytesnacks` code or documentation.