Adds Examples to documentation

skops-dev · Jan 26, 2023 · 1ab80e4 · 1ab80e4
1 parent 5c75d7c
commit 1ab80e4
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -0,0 +1,9 @@
+.. _examples:
+
+Examples of using skops
+=======================
+
+- Tabular Regression:
+    `Here <https://github.com/skops-dev/skops/blob/main/examples/plot_tabular_classification.py>`_ is an example of using skops to serialize a tabular regression model and create a model card and a Hugging Face Hub repository.
+- Text Classification:
+    `Here <https://github.com/skops-dev/skops/blob/main/examples/plot_text_classification.py>`_ is an example of using skops to serialize a text classification model and create a model card and a Hugging Face Hub repository.
diff --git a/docs/index.rst b/docs/index.rst
@@ -40,6 +40,7 @@ User Guide / API Reference
    model_card
    persistence
    modules/classes
+   examples
 
 Community / About
 =================