/flytesnacks

Flyte Learn by Examples. Generated documentation - https://flytecookbook.readthedocs.io/en/latest/

Primary LanguagePythonApache License 2.0Apache-2.0

Flyte Logo

Flyte User Guide & Tutorials

Flytesnacks encompasses code examples built on top of Flytekit Python

User Guide · Tutorials · Contribution Guide

🚀 Quick Start

To get the hang of Python SDK, refer to the Getting Started tutorial before exploring the examples.

User Guide section has code examples, tips, and tricks that showcase the usage of Flyte features and integrations.

Tutorials section has real-world examples, ranging from machine learning training, data processing to feature engineering.

📖 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 <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 to get acquainted with the guidelines.

🐞 File an Issue

Refer to the issues section in the contribution guide if you'd like to file an issue relating to flytesnacks code or documentation.