docs(framework) Add description metadata to Flower Quickstart docs (#…

…4214)
jeremiahp111 · Jan 12, 2025 · cb8a08d · cb8a08d
1 parent b8b459e
commit cb8a08d
Show file tree

Hide file tree

Showing 9 changed files with 36 additions and 9 deletions.
diff --git a/framework/docs/source/tutorial-quickstart-fastai.rst b/framework/docs/source/tutorial-quickstart-fastai.rst
@@ -1,3 +1,7 @@
+:og:description: Learn how to train a SqueezeNet model on MNIST using federated learning with Flower and fastai in this step-by-step tutorial.
+.. meta::
+    :description: Learn how to train a SqueezeNet model on MNIST using federated learning with Flower and fastai in this step-by-step tutorial.
+
 .. _quickstart-fastai:
 
 Quickstart fastai

diff --git a/framework/docs/source/tutorial-quickstart-huggingface.rst b/framework/docs/source/tutorial-quickstart-huggingface.rst
@@ -1,3 +1,7 @@
+:og:description: Learn how to train a large language model on the IMDB dataset using federated learning with Flower and 🤗 Hugging Face in this step-by-step tutorial.
+.. meta::
+    :description: Learn how to train a large language model on the IMDB dataset using federated learning with Flower and 🤗 Hugging Face in this step-by-step tutorial.
+
 .. _quickstart-huggingface:
 
 Quickstart 🤗 Transformers
@@ -398,6 +402,3 @@ for an LLM.
 .. _quickstart_hf_link: https://github.com/adap/flower/tree/main/examples/quickstart-huggingface
 
 .. _serverappcomponents: ref-api/flwr.server.ServerAppComponents.html#serverappcomponents
-
-.. meta::
-    :description: Check out this Federating Learning quickstart tutorial for using Flower with 🤗 HuggingFace Transformers in order to fine-tune an LLM.
diff --git a/framework/docs/source/tutorial-quickstart-jax.rst b/framework/docs/source/tutorial-quickstart-jax.rst
@@ -1,3 +1,7 @@
+:og:description: Learn how to train a linear regression using federated learning with Flower and JAX in this step-by-step tutorial.
+.. meta::
+    :description: Learn how to train a linear regression using federated learning with Flower and JAX in this step-by-step tutorial.
+
 .. _quickstart-jax:
 
 Quickstart JAX

diff --git a/framework/docs/source/tutorial-quickstart-mlx.rst b/framework/docs/source/tutorial-quickstart-mlx.rst
@@ -1,3 +1,7 @@
+:og:description: Learn how to train an MLP on MNIST using federated learning with Flower and MLX in this step-by-step tutorial.
+.. meta::
+    :description: Learn how to train an MLP on MNIST using federated learning with Flower and MLX in this step-by-step tutorial.
+
 .. _quickstart-mlx:
 
 Quickstart MLX

diff --git a/framework/docs/source/tutorial-quickstart-pytorch-lightning.rst b/framework/docs/source/tutorial-quickstart-pytorch-lightning.rst
@@ -1,3 +1,7 @@
+:og:description: Learn how to train an autoencoder on MNIST using federated learning with Flower and PyTorch Lightning in this step-by-step tutorial.
+.. meta::
+    :description: Learn how to train an autoencoder on MNIST using federated learning with Flower and PyTorch Lightning in this step-by-step tutorial.
+
 .. _quickstart-pytorch-lightning:
 
 Quickstart PyTorch Lightning

diff --git a/framework/docs/source/tutorial-quickstart-pytorch.rst b/framework/docs/source/tutorial-quickstart-pytorch.rst
@@ -1,3 +1,7 @@
+:og:description: Learn how to train a Convolutional Neural Network on CIFAR-10 using federated learning with Flower and PyTorch in this step-by-step tutorial.
+.. meta::
+    :description: Learn how to train a Convolutional Neural Network on CIFAR-10 using federated learning with Flower and PyTorch in this step-by-step tutorial.
+
 .. _quickstart-pytorch:
 
 Quickstart PyTorch
@@ -359,8 +363,5 @@ Video tutorial
     previously recommended APIs. A new video tutorial will be released that shows the
     new APIs (as the content above does)
 
-.. meta::
-    :description: Check out this Federated Learning quickstart tutorial for using Flower with PyTorch to train a CNN model on MNIST.
-
 .. youtube:: jOmmuzMIQ4c
     :width: 100%
diff --git a/framework/docs/source/tutorial-quickstart-scikitlearn.rst b/framework/docs/source/tutorial-quickstart-scikitlearn.rst
@@ -1,3 +1,7 @@
+:og:description: Learn how to train a logistic regression on MNIST using federated learning with Flower and scikit-learn in this step-by-step tutorial.
+.. meta::
+    :description: Learn how to train a logistic regression on MNIST using federated learning with Flower and scikit-learn in this step-by-step tutorial.
+
 .. _quickstart-scikitlearn:
 
 Quickstart scikit-learn

diff --git a/framework/docs/source/tutorial-quickstart-tensorflow.rst b/framework/docs/source/tutorial-quickstart-tensorflow.rst
@@ -1,3 +1,7 @@
+:og:description: Learn how to train a Convolutional Neural Network on CIFAR-10 using federated learning with Flower and TensorFlow in this step-by-step tutorial.
+.. meta::
+    :description: Learn how to train a Convolutional Neural Network on CIFAR-10 using federated learning with Flower and TensorFlow in this step-by-step tutorial.
+
 .. _quickstart-tensorflow:
 
 Quickstart TensorFlow
@@ -283,8 +287,5 @@ Video tutorial
     previously recommended APIs. A new video tutorial will be released that shows the
     new APIs (as the content above does)
 
-.. meta::
-    :description: Check out this Federated Learning quickstart tutorial for using Flower with TensorFlow to train a CNN model on CIFAR-10.
-
 .. youtube:: FGTc2TQq7VM
     :width: 100%
diff --git a/framework/docs/source/tutorial-quickstart-xgboost.rst b/framework/docs/source/tutorial-quickstart-xgboost.rst
@@ -1,3 +1,7 @@
+:og:description: Learn how to train a classification model on the Higgs dataset using federated learning with Flower and XGBoost in this step-by-step tutorial.
+.. meta::
+    :description: Learn how to train a classification model on the Higgs dataset using federated learning with Flower and XGBoost in this step-by-step tutorial.
+
 .. _quickstart-xgboost:
 
 Quickstart XGBoost