forked from flyteorg/flyte
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6e3e0e6
commit f139b56
Showing
1 changed file
with
49 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,56 @@ | ||
| # flytesnacks: Deep Dive into Flyte | ||
| <html> | ||
| <p align="center"> | ||
| <img src="https://github.com/flyteorg/flyte/blob/master/rsts/images/flyte_circle_gradient_1_4x4.png" alt="Flyte Logo" width="100"> | ||
| </p> | ||
| <h1 align="center"> | ||
| Flyte User Guide & Tutorials | ||
| </h1> | ||
| <p align="center"> | ||
| Flytesnacks encompasses code examples built on top of Flytekit Python | ||
| </p> | ||
| <h3 align="center"> | ||
| <a href="https://docs.flyte.org/projects/cookbook/en/latest/index.html">User Guide</a> | ||
| <span> · </span> | ||
| <a href="https://docs.flyte.org/projects/cookbook/en/latest/tutorials.html">Tutorials</a> | ||
| <span> · </span> | ||
| <a href="#contribution-guide">Contribution Guide</a> | ||
| </h3> | ||
| </html> | ||
|
|
||
| ## Goal | ||
| Create a single repository that will provide useful snippets, examples and demos for using Flyte. | ||
| <html> | ||
| <h2 id="quick-start"> | ||
| 🚀 Quick Start | ||
| </h2> | ||
| </html> | ||
|
|
||
| ## 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) | ||
| <html> | ||
| <h2 id="contribution-guide"> | ||
| 📖 Contribution Guide | ||
| </h2> | ||
| </html> | ||
|
|
||
| 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 <directory> 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. | ||
|
|
||
| <html> | ||
| <h2 id="file-an-issue"> | ||
| 🐞 File an Issue | ||
| </h2> | ||
| </html> | ||
|
|
||
| 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. |