From caadd269af894e50b88c911bbda38ffeaf0a1bb5 Mon Sep 17 00:00:00 2001
From: Nikki Everett
Date: Fri, 4 Oct 2024 13:23:34 -0500
Subject: [PATCH] Updates for Flyte docs overhaul (#1726)
* moved to flyte repo
Signed-off-by: nikki everett
* update refs
Signed-off-by: nikki everett
* update refs in examples
Signed-off-by: nikki everett
* configure pydata theme
Signed-off-by: nikki everett
* restructure integrations docs
Signed-off-by: nikki everett
* restructure tutorials
Signed-off-by: nikki everett
* fix contributing guide link
Signed-off-by: nikki everett
* remove double h1
Signed-off-by: nikki everett
* remove unneceesary captions
Signed-off-by: nikki everett
* move deprecated integrations back to flytesnacks and remove unnecessary captions from tutorials and integrations toctrees
Signed-off-by: nikki everett
* fix regression
Signed-off-by: nikki everett
* linting
Signed-off-by: nikki everett
* update docs-requirements.txt from new docs-requirements.in
Signed-off-by: nikki everett
* update README
Signed-off-by: nikki everett
* Regenerate all requirements files using python 3.9
Signed-off-by: Eduardo Apolinario
* Regenerate readthedocs requirements files using python 3.12
Signed-off-by: Eduardo Apolinario
* fix formatting for deprecated plugins
Signed-off-by: nikki everett
* Add pandas to requirements.in in a bunch of places
Signed-off-by: Eduardo Apolinario
* Install pandas in e2e-tests
Signed-off-by: Eduardo Apolinario
* use ref for docs contributing guide
Signed-off-by: nikki everett
---------
Signed-off-by: nikki everett
Signed-off-by: Eduardo Apolinario
Co-authored-by: Eduardo Apolinario
---
.github/workflows/checks.yml | 2 +-
.readthedocs.yml | 2 +-
README.md | 14 +-
dev-requirements.txt | 307 +++++-----
docs-requirements.in | 7 +-
docs-requirements.txt | 531 ++++++------------
docs/conf.py | 12 +-
docs/contribute.md | 359 ------------
docs/index.md | 139 +----
.../deprecated_integrations/index.md | 10 +
.../index.md} | 114 ++--
.../bioinformatics/index.md} | 4 +-
.../feature_engineering/index.md} | 10 +-
.../flytelab/index.md} | 0
.../flytelab}/weather_forecasting.md | 0
docs/{tutorials.md => tutorials/index.md} | 35 +-
.../model_training/index.md} | 22 +-
.../airflow_plugin/airflow_plugin/airflow.py | 2 +-
examples/bigquery_agent/requirements.in | 1 +
examples/bigquery_plugin/README.md | 13 +-
.../bigquery_plugin_example.py | 6 +
examples/bigquery_plugin/requirements.in | 1 +
examples/blast/requirements.in | 1 +
examples/databricks_plugin/README.md | 13 +-
.../databricks_plugin_example.py | 6 +
.../development_lifecycle/requirements.in | 1 +
examples/house_price_prediction/README.md | 2 +-
.../house_price_prediction/requirements.in | 1 +
examples/k8s_dask_plugin/README.md | 2 +-
examples/k8s_pod_plugin/README.md | 2 +-
examples/k8s_spark_plugin/README.md | 4 +-
examples/kfpytorch_plugin/README.md | 2 +-
examples/kftensorflow_plugin/README.md | 2 +-
.../mmcloud_agent_example_usage.py | 2 +-
examples/pima_diabetes/requirements.in | 1 +
examples/ray_plugin/README.md | 2 +-
examples/snowflake_plugin/README.md | 13 +-
examples/snowflake_plugin/snowflake_plugin.md | 2 +-
.../snowflake_plugin_example.py | 5 +
examples/whylogs_plugin/requirements.in | 1 +
40 files changed, 550 insertions(+), 1103 deletions(-)
delete mode 100644 docs/contribute.md
create mode 100644 docs/integrations/deprecated_integrations/index.md
rename docs/{integrations.md => integrations/index.md} (63%)
rename docs/{bioinformatics_examples.md => tutorials/bioinformatics/index.md} (81%)
rename docs/{feature_engineering.md => tutorials/feature_engineering/index.md} (62%)
rename docs/{flyte_lab.md => tutorials/flytelab/index.md} (100%)
rename docs/{ => tutorials/flytelab}/weather_forecasting.md (100%)
rename docs/{tutorials.md => tutorials/index.md} (62%)
rename docs/{ml_training.md => tutorials/model_training/index.md} (50%)
diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml
index ead9fa466..f88c21953 100644
--- a/.github/workflows/checks.yml
+++ b/.github/workflows/checks.yml
@@ -293,7 +293,7 @@ jobs:
pip install uv
uv venv
source .venv/bin/activate
- uv pip install "flytekit>=1.12.2" flytekitplugins-deck-standard torch tabulate pyarrow
+ uv pip install "flytekit>=1.12.2" flytekitplugins-deck-standard torch tabulate pyarrow pandas
pip freeze
- name: Checkout flytesnacks
uses: actions/checkout@v3
diff --git a/.readthedocs.yml b/.readthedocs.yml
index b1825c215..796b75d7d 100644
--- a/.readthedocs.yml
+++ b/.readthedocs.yml
@@ -7,7 +7,7 @@ version: 2
build:
os: "ubuntu-22.04"
tools:
- python: "3.11"
+ python: "3.12"
apt_packages:
- pandoc
diff --git a/README.md b/README.md
index bd2e73154..f6ad212d4 100644
--- a/README.md
+++ b/README.md
@@ -3,10 +3,10 @@
- Flyte User Guide & Tutorials
+ Flyte tutorials and integrations examples
- Flytesnacks encompasses code examples showcasing Flytekit Python
+ Flytesnacks encompasses tutorials and integrations examples showcasing Flytekit Python
@@ -30,11 +30,9 @@
> 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.
-The [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.
+The [Tutorials](https://docs.flyte.org/en/latest/flytesnacks/tutorials/index.html) section has real-world examples, ranging from machine learning training, data processing to feature engineering.
-The [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.
-
-the [Integrations](https://docs.flyte.org/projects/cookbook/en/latest/integrations.html) section demonstrates how to use Flyte with other tools and frameworks.
+the [Integrations](https://docs.flyte.org/en/latest/flytesnacks/integrations/index.html) section demonstrates how to use Flyte with other tools and frameworks.
> Flytesnacks currently has all examples in Python (Flytekit Python SDK).
@@ -44,7 +42,7 @@ the [Integrations](https://docs.flyte.org/projects/cookbook/en/latest/integratio