pushing files to the repo from the example!

README.md

@@ -0,0 +1,219 @@
+---
+library_name: sklearn
+tags:
+- sklearn
+- skops
+- tabular-classification
+model_file: skops-bo_9fb88.pkl
+widget:
+  structuredData:
+    area error:
+    - 30.29
+    - 96.05
+    - 48.31
+    compactness error:
+    - 0.01911
+    - 0.01652
+    - 0.01484
+    concave points error:
+    - 0.01037
+    - 0.0137
+    - 0.01093
+    concavity error:
+    - 0.02701
+    - 0.02269
+    - 0.02813
+    fractal dimension error:
+    - 0.003586
+    - 0.001698
+    - 0.002461
+    mean area:
+    - 481.9
+    - 1130.0
+    - 748.9
+    mean compactness:
+    - 0.1058
+    - 0.1029
+    - 0.1223
+    mean concave points:
+    - 0.03821
+    - 0.07951
+    - 0.08087
+    mean concavity:
+    - 0.08005
+    - 0.108
+    - 0.1466
+    mean fractal dimension:
+    - 0.06373
+    - 0.05461
+    - 0.05796
+    mean perimeter:
+    - 81.09
+    - 123.6
+    - 101.7
+    mean radius:
+    - 12.47
+    - 18.94
+    - 15.46
+    mean smoothness:
+    - 0.09965
+    - 0.09009
+    - 0.1092
+    mean symmetry:
+    - 0.1925
+    - 0.1582
+    - 0.1931
+    mean texture:
+    - 18.6
+    - 21.31
+    - 19.48
+    perimeter error:
+    - 2.497
+    - 5.486
+    - 3.094
+    radius error:
+    - 0.3961
+    - 0.7888
+    - 0.4743
+    smoothness error:
+    - 0.006953
+    - 0.004444
+    - 0.00624
+    symmetry error:
+    - 0.01782
+    - 0.01386
+    - 0.01397
+    texture error:
+    - 1.044
+    - 0.7975
+    - 0.7859
+    worst area:
+    - 677.9
+    - 1866.0
+    - 1156.0
+    worst compactness:
+    - 0.2378
+    - 0.2336
+    - 0.2394
+    worst concave points:
+    - 0.1015
+    - 0.1789
+    - 0.1514
+    worst concavity:
+    - 0.2671
+    - 0.2687
+    - 0.3791
+    worst fractal dimension:
+    - 0.0875
+    - 0.06589
+    - 0.08019
+    worst perimeter:
+    - 96.05
+    - 165.9
+    - 124.9
+    worst radius:
+    - 14.97
+    - 24.86
+    - 19.26
+    worst smoothness:
+    - 0.1426
+    - 0.1193
+    - 0.1546
+    worst symmetry:
+    - 0.3014
+    - 0.2551
+    - 0.2837
+    worst texture:
+    - 24.64
+    - 26.58
+    - 26.0
+---
+
+# Model description
+
+[More Information Needed]
+
+## Intended uses & limitations
+
+[More Information Needed]
+
+## Training Procedure
+
+### Hyperparameters
+
+The model is trained with below hyperparameters.
+
+<details>
+<summary> Click to expand </summary>
+
+| Hyperparameter                  | Value                                                    |
+|---------------------------------|----------------------------------------------------------|
+| aggressive_elimination          | False                                                    |
+| cv                              | 5                                                        |
+| error_score                     | nan                                                      |
+| estimator__categorical_features |                                                          |
+| estimator__early_stopping       | auto                                                     |
+| estimator__l2_regularization    | 0.0                                                      |
+| estimator__learning_rate        | 0.1                                                      |
+| estimator__loss                 | log_loss                                                 |
+| estimator__max_bins             | 255                                                      |
+| estimator__max_depth            |                                                          |
+| estimator__max_iter             | 100                                                      |
+| estimator__max_leaf_nodes       | 31                                                       |
+| estimator__min_samples_leaf     | 20                                                       |
+| estimator__monotonic_cst        |                                                          |
+| estimator__n_iter_no_change     | 10                                                       |
+| estimator__random_state         |                                                          |
+| estimator__scoring              | loss                                                     |
+| estimator__tol                  | 1e-07                                                    |
+| estimator__validation_fraction  | 0.1                                                      |
+| estimator__verbose              | 0                                                        |
+| estimator__warm_start           | False                                                    |
+| estimator                       | HistGradientBoostingClassifier()                         |
+| factor                          | 3                                                        |
+| max_resources                   | auto                                                     |
+| min_resources                   | exhaust                                                  |
+| n_jobs                          | -1                                                       |
+| param_grid                      | {'max_leaf_nodes': [5, 10, 15], 'max_depth': [2, 5, 10]} |
+| random_state                    | 42                                                       |
+| refit                           | True                                                     |
+| resource                        | n_samples                                                |
+| return_train_score              | True                                                     |
+| scoring                         |                                                          |
+| verbose                         | 0                                                        |
+
+</details>
+
+### Model Plot
+
+The model plot is below.
+
+<style>#sk-container-id-1 {color: black;background-color: white;}#sk-container-id-1 pre{padding: 0;}#sk-container-id-1 div.sk-toggleable {background-color: white;}#sk-container-id-1 label.sk-toggleable__label {cursor: pointer;display: block;width: 100%;margin-bottom: 0;padding: 0.3em;box-sizing: border-box;text-align: center;}#sk-container-id-1 label.sk-toggleable__label-arrow:before {content: "▸";float: left;margin-right: 0.25em;color: #696969;}#sk-container-id-1 label.sk-toggleable__label-arrow:hover:before {color: black;}#sk-container-id-1 div.sk-estimator:hover label.sk-toggleable__label-arrow:before {color: black;}#sk-container-id-1 div.sk-toggleable__content {max-height: 0;max-width: 0;overflow: hidden;text-align: left;background-color: #f0f8ff;}#sk-container-id-1 div.sk-toggleable__content pre {margin: 0.2em;color: black;border-radius: 0.25em;background-color: #f0f8ff;}#sk-container-id-1 input.sk-toggleable__control:checked~div.sk-toggleable__content {max-height: 200px;max-width: 100%;overflow: auto;}#sk-container-id-1 input.sk-toggleable__control:checked~label.sk-toggleable__label-arrow:before {content: "▾";}#sk-container-id-1 div.sk-estimator input.sk-toggleable__control:checked~label.sk-toggleable__label {background-color: #d4ebff;}#sk-container-id-1 div.sk-label input.sk-toggleable__control:checked~label.sk-toggleable__label {background-color: #d4ebff;}#sk-container-id-1 input.sk-hidden--visually {border: 0;clip: rect(1px 1px 1px 1px);clip: rect(1px, 1px, 1px, 1px);height: 1px;margin: -1px;overflow: hidden;padding: 0;position: absolute;width: 1px;}#sk-container-id-1 div.sk-estimator {font-family: monospace;background-color: #f0f8ff;border: 1px dotted black;border-radius: 0.25em;box-sizing: border-box;margin-bottom: 0.5em;}#sk-container-id-1 div.sk-estimator:hover {background-color: #d4ebff;}#sk-container-id-1 div.sk-parallel-item::after {content: "";width: 100%;border-bottom: 1px solid gray;flex-grow: 1;}#sk-container-id-1 div.sk-label:hover label.sk-toggleable__label {background-color: #d4ebff;}#sk-container-id-1 div.sk-serial::before {content: "";position: absolute;border-left: 1px solid gray;box-sizing: border-box;top: 0;bottom: 0;left: 50%;z-index: 0;}#sk-container-id-1 div.sk-serial {display: flex;flex-direction: column;align-items: center;background-color: white;padding-right: 0.2em;padding-left: 0.2em;position: relative;}#sk-container-id-1 div.sk-item {position: relative;z-index: 1;}#sk-container-id-1 div.sk-parallel {display: flex;align-items: stretch;justify-content: center;background-color: white;position: relative;}#sk-container-id-1 div.sk-item::before, #sk-container-id-1 div.sk-parallel-item::before {content: "";position: absolute;border-left: 1px solid gray;box-sizing: border-box;top: 0;bottom: 0;left: 50%;z-index: -1;}#sk-container-id-1 div.sk-parallel-item {display: flex;flex-direction: column;z-index: 1;position: relative;background-color: white;}#sk-container-id-1 div.sk-parallel-item:first-child::after {align-self: flex-end;width: 50%;}#sk-container-id-1 div.sk-parallel-item:last-child::after {align-self: flex-start;width: 50%;}#sk-container-id-1 div.sk-parallel-item:only-child::after {width: 0;}#sk-container-id-1 div.sk-dashed-wrapped {border: 1px dashed gray;margin: 0 0.4em 0.5em 0.4em;box-sizing: border-box;padding-bottom: 0.4em;background-color: white;}#sk-container-id-1 div.sk-label label {font-family: monospace;font-weight: bold;display: inline-block;line-height: 1.2em;}#sk-container-id-1 div.sk-label-container {text-align: center;}#sk-container-id-1 div.sk-container {/* jupyter's `normalize.less` sets `[hidden] { display: none; }` but bootstrap.min.css set `[hidden] { display: none !important; }` so we also need the `!important` here to be able to override the default hidden behavior on the sphinx rendered scikit-learn.org. See: https://github.com/scikit-learn/scikit-learn/issues/21755 */display: inline-block !important;position: relative;}#sk-container-id-1 div.sk-text-repr-fallback {display: none;}</style><div id="sk-container-id-1" class="sk-top-container" style="overflow: auto;"><div class="sk-text-repr-fallback"><pre>HalvingGridSearchCV(estimator=HistGradientBoostingClassifier(), n_jobs=-1,param_grid={&#x27;max_depth&#x27;: [2, 5, 10],&#x27;max_leaf_nodes&#x27;: [5, 10, 15]},random_state=42)</pre><b>In a Jupyter environment, please rerun this cell to show the HTML representation or trust the notebook. <br />On GitHub, the HTML representation is unable to render, please try loading this page with nbviewer.org.</b></div><div class="sk-container" hidden><div class="sk-item sk-dashed-wrapped"><div class="sk-label-container"><div class="sk-label sk-toggleable"><input class="sk-toggleable__control sk-hidden--visually" id="sk-estimator-id-1" type="checkbox" ><label for="sk-estimator-id-1" class="sk-toggleable__label sk-toggleable__label-arrow">HalvingGridSearchCV</label><div class="sk-toggleable__content"><pre>HalvingGridSearchCV(estimator=HistGradientBoostingClassifier(), n_jobs=-1,param_grid={&#x27;max_depth&#x27;: [2, 5, 10],&#x27;max_leaf_nodes&#x27;: [5, 10, 15]},random_state=42)</pre></div></div></div><div class="sk-parallel"><div class="sk-parallel-item"><div class="sk-item"><div class="sk-label-container"><div class="sk-label sk-toggleable"><input class="sk-toggleable__control sk-hidden--visually" id="sk-estimator-id-2" type="checkbox" ><label for="sk-estimator-id-2" class="sk-toggleable__label sk-toggleable__label-arrow">estimator: HistGradientBoostingClassifier</label><div class="sk-toggleable__content"><pre>HistGradientBoostingClassifier()</pre></div></div></div><div class="sk-serial"><div class="sk-item"><div class="sk-estimator sk-toggleable"><input class="sk-toggleable__control sk-hidden--visually" id="sk-estimator-id-3" type="checkbox" ><label for="sk-estimator-id-3" class="sk-toggleable__label sk-toggleable__label-arrow">HistGradientBoostingClassifier</label><div class="sk-toggleable__content"><pre>HistGradientBoostingClassifier()</pre></div></div></div></div></div></div></div></div></div></div>
+
+## Evaluation Results
+
+[More Information Needed]
+
+# How to Get Started with the Model
+
+[More Information Needed]
+
+# Model Card Authors
+
+This model card is written by following authors:
+
+[More Information Needed]
+
+# Model Card Contact
+
+You can contact the model card authors through following channels:
+[More Information Needed]
+
+# Citation
+
+Below you can find information related to citation.
+
+**BibTeX:**
+```
+[More Information Needed]
+```

config.json

@@ -0,0 +1,196 @@
+{
+    "sklearn": {
+        "columns": [
+            "mean radius",
+            "mean texture",
+            "mean perimeter",
+            "mean area",
+            "mean smoothness",
+            "mean compactness",
+            "mean concavity",
+            "mean concave points",
+            "mean symmetry",
+            "mean fractal dimension",
+            "radius error",
+            "texture error",
+            "perimeter error",
+            "area error",
+            "smoothness error",
+            "compactness error",
+            "concavity error",
+            "concave points error",
+            "symmetry error",
+            "fractal dimension error",
+            "worst radius",
+            "worst texture",
+            "worst perimeter",
+            "worst area",
+            "worst smoothness",
+            "worst compactness",
+            "worst concavity",
+            "worst concave points",
+            "worst symmetry",
+            "worst fractal dimension"
+        ],
+        "environment": [
+            "scikit-learn=1.1.1"
+        ],
+        "example_input": {
+            "area error": [
+                30.29,
+                96.05,
+                48.31
+            ],
+            "compactness error": [
+                0.01911,
+                0.01652,
+                0.01484
+            ],
+            "concave points error": [
+                0.01037,
+                0.0137,
+                0.01093
+            ],
+            "concavity error": [
+                0.02701,
+                0.02269,
+                0.02813
+            ],
+            "fractal dimension error": [
+                0.003586,
+                0.001698,
+                0.002461
+            ],
+            "mean area": [
+                481.9,
+                1130.0,
+                748.9
+            ],
+            "mean compactness": [
+                0.1058,
+                0.1029,
+                0.1223
+            ],
+            "mean concave points": [
+                0.03821,
+                0.07951,
+                0.08087
+            ],
+            "mean concavity": [
+                0.08005,
+                0.108,
+                0.1466
+            ],
+            "mean fractal dimension": [
+                0.06373,
+                0.05461,
+                0.05796
+            ],
+            "mean perimeter": [
+                81.09,
+                123.6,
+                101.7
+            ],
+            "mean radius": [
+                12.47,
+                18.94,
+                15.46
+            ],
+            "mean smoothness": [
+                0.09965,
+                0.09009,
+                0.1092
+            ],
+            "mean symmetry": [
+                0.1925,
+                0.1582,
+                0.1931
+            ],
+            "mean texture": [
+                18.6,
+                21.31,
+                19.48
+            ],
+            "perimeter error": [
+                2.497,
+                5.486,
+                3.094
+            ],
+            "radius error": [
+                0.3961,
+                0.7888,
+                0.4743
+            ],
+            "smoothness error": [
+                0.006953,
+                0.004444,
+                0.00624
+            ],
+            "symmetry error": [
+                0.01782,
+                0.01386,
+                0.01397
+            ],
+            "texture error": [
+                1.044,
+                0.7975,
+                0.7859
+            ],
+            "worst area": [
+                677.9,
+                1866.0,
+                1156.0
+            ],
+            "worst compactness": [
+                0.2378,
+                0.2336,
+                0.2394
+            ],
+            "worst concave points": [
+                0.1015,
+                0.1789,
+                0.1514
+            ],
+            "worst concavity": [
+                0.2671,
+                0.2687,
+                0.3791
+            ],
+            "worst fractal dimension": [
+                0.0875,
+                0.06589,
+                0.08019
+            ],
+            "worst perimeter": [
+                96.05,
+                165.9,
+                124.9
+            ],
+            "worst radius": [
+                14.97,
+                24.86,
+                19.26
+            ],
+            "worst smoothness": [
+                0.1426,
+                0.1193,
+                0.1546
+            ],
+            "worst symmetry": [
+                0.3014,
+                0.2551,
+                0.2837
+            ],
+            "worst texture": [
+                24.64,
+                26.58,
+                26.0
+            ]
+        },
+        "model": {
+            "file": "skops-bo_9fb88.pkl"
+        },
+        "model_format": "pickle",
+        "task": "tabular-classification"
+    }
+}

plot_hf_hub.py

@@ -0,0 +1,172 @@
+"""
+scikit-learn models on Hugging Face Hub
+---------------------------------------
+
+This guide demonstrates how you can use this package to create a Hugging Face
+Hub model repository based on a scikit-learn compatible model, and how to
+fetch scikit-learn compatible models from the Hub and run them locally.
+"""
+
+# %%
+# Imports
+# =======
+# First we will import everything required for the rest of this document.
+
+import json
+import os
+import pickle
+from pathlib import Path
+from tempfile import mkdtemp, mkstemp
+from uuid import uuid4
+
+import sklearn
+from huggingface_hub import HfApi
+from sklearn.datasets import load_breast_cancer
+from sklearn.ensemble import HistGradientBoostingClassifier
+from sklearn.experimental import enable_halving_search_cv  # noqa
+from sklearn.model_selection import HalvingGridSearchCV, train_test_split
+
+from skops import card, hub_utils
+
+# %%
+# Data
+# ====
+# Then we create some random data to train and evaluate our model.
+
+X, y = load_breast_cancer(as_frame=True, return_X_y=True)
+X_train, X_test, y_train, y_test = train_test_split(
+    X, y, test_size=0.3, random_state=42
+)
+print("X's summary: ", X.describe())
+print("y's summary: ", y.describe())
+
+
+# %%
+# Train a Model
+# =============
+# Using the above data, we train a model. To select the model, we use
+# :class:`~sklearn.model_selection.HalvingGridSearchCV` with a parameter grid
+# over :class:`~sklearn.ensemble.HistGradientBoostingClassifier`.
+
+param_grid = {
+    "max_leaf_nodes": [5, 10, 15],
+    "max_depth": [2, 5, 10],
+}
+
+model = HalvingGridSearchCV(
+    estimator=HistGradientBoostingClassifier(),
+    param_grid=param_grid,
+    random_state=42,
+    n_jobs=-1,
+).fit(X_train, y_train)
+model.score(X_test, y_test)
+
+# %%
+# Initialize a Model Repo
+# =======================
+# We now initialize a model repository locally, and push it to the hub. For
+# that, we need to first store the model as a pickle file and pass it to the
+# hub tools.
+
+# The file name is not significant, here we choose to save it with a `pkl`
+# extension.
+_, pkl_name = mkstemp(prefix="skops-", suffix=".pkl")
+with open(pkl_name, mode="bw") as f:
+    pickle.dump(model, file=f)
+
+local_repo = mkdtemp(prefix="skops-")
+hub_utils.init(
+    model=pkl_name,
+    requirements=[f"scikit-learn={sklearn.__version__}"],
+    dst=local_repo,
+    task="tabular-classification",
+    data=X_test,
+)
+if "__file__" in locals():  # __file__ not defined during docs built
+    # Add this script itself to the files to be uploaded for reproducibility
+    hub_utils.add_files(__file__, dst=local_repo)
+
+# %%
+# We can no see what the contents of the created local repo are:
+print(os.listdir(local_repo))
+
+# %%
+# Model Card
+# ==========
+# We will now create a model card and save it. For more information about how
+# to create a good model card, refer to the :ref:`model card example
+# <sphx_glr_auto_examples_plot_model_card.py>`. The following code uses
+# :func:`~skops.card.metadata_from_config` which creates a minimal metadata
+# object to be included in the metadata section of the model card. The
+# configuration used by this method is stored in the ``config.json`` file which
+# is created by the call to :func:`~skops.hub_utils.init`.
+model_card = card.Card(model, metadata=card.metadata_from_config(Path(local_repo)))
+model_card.save(Path(local_repo) / "README.md")
+
+# %%
+# Push to Hub
+# ===========
+# And finally, we can push the model to the hub. This requires a user access
+# token which you can get under https://huggingface.co/settings/tokens
+
+# you can put your own token here, or set it as an environment variable before
+# running this script.
+token = os.environ["HF_HUB_TOKEN"]
+
+repo_name = f"hf_hub_example-{uuid4()}"
+user_name = HfApi().whoami(token=token)["name"]
+repo_id = f"{user_name}/{repo_name}"
+print(f"Creating and pushing to repo: {repo_id}")
+
+# %%
+# Now we can push our files to the repo. The following function creates the
+# remote repository if it doesn't exist; this is controlled via the
+# ``create_remote`` argument. Note that here we're setting ``private=True``,
+# which means only people with the right permissions would see the model. Set
+# ``private=False`` to make it visible to the public.
+
+hub_utils.push(
+    repo_id=repo_id,
+    source=local_repo,
+    token=token,
+    commit_message="pushing files to the repo from the example!",
+    create_remote=True,
+    private=True,
+)
+
+# %%
+# Once uploaded, other users can download and use it, unless you make the repo
+# private. Given a repository's name, here's how one can download it:
+repo_copy = mkdtemp(prefix="skops")
+hub_utils.download(repo_id=repo_id, dst=repo_copy, token=token)
+print(os.listdir(repo_copy))
+
+
+# %%
+# You can also get the requirements of this repository:
+print(hub_utils.get_requirements(path=repo_copy))
+
+# %%
+# As well as the complete configuration of the project:
+print(json.dumps(hub_utils.get_config(path=repo_copy), indent=2))
+
+# %%
+# Now you can check the contents of the repository under your user.
+#
+# Update Requirements
+# ===================
+# If you update your environment and the versions of your requirements are
+# changed, you can update the requirement in your repo by calling
+# ``update_env``, which automatically detects the existing installation of the
+# current environment and updates the requirements accordingly.
+
+hub_utils.update_env(path=local_repo, requirements=["scikit-learn"])
+
+# %%
+# Delete Repository
+# =================
+# At the end, you can also delete the repository you created using
+# ``HfApi().delete_repo``. For more information please refer to the
+# documentation of ``huggingface_hub`` library.
+
+#HfApi().delete_repo(repo_id=repo_id, token=token)

skops-bo_9fb88.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:f7315c566432a5873ff9d7939376a74dc78b81f3df99ff7e72b504dc6f558e84
+size 233388