Create app.py

app.py

@@ -0,0 +1,141 @@
+import pandas as pd
+import requests
+import streamlit as st
+from modelcards import ModelCard
+
+
+@st.cache
+def get_cached_data():
+    languages_df = pd.read_html("https://hf.co/languages")[0]
+    languages_map = pd.Series(languages_df["Language"].values, index=languages_df["ISO code"]).to_dict()
+
+    license_df = pd.read_html("https://huggingface.co/docs/hub/repositories-licenses")[0]
+    license_map = pd.Series(
+        license_df["License identifier (to use in model card)"].values, index=license_df.Fullname
+    ).to_dict()
+
+    available_metrics = [x['id'] for x in requests.get('https://huggingface.co/api/metrics').json()]
+
+    return languages_map, license_map, available_metrics
+
+
+languages_map, license_map, available_metrics = get_cached_data()
+
+with st.sidebar:
+    st.title("Model Card Creator")
+    st.markdown("This app lets you generate model cards for your 🤗 Hub model repo!")
+    view = st.selectbox("View", ["Markdown", "Raw Text", "How to Programmatically Generate"])
+    warning_placeholder = st.empty()
+    placeholder = st.empty()
+    st.markdown('---')
+
+    model_name = st.text_input(
+        "Model Name", "my-cool-model", help="The name of your model. (Ex. my-cool-model, bert-base-uncased, etc.)"
+    )
+    languages = (
+        st.multiselect(
+            "Language",
+            languages_map.keys(),
+            format_func=lambda x: languages_map[x],
+            help="The language(s) associated with this model. If this is not a text-based model, you should specify whatever lanuage is used in the dataset. For instance, if the dataset's labels are in english, you should select English here.",
+        )
+        or None
+    )
+    license = st.selectbox("License", license_map.keys(), 33, help="The license associated with this model.")
+    library_name = (
+        st.text_input(
+            "Library Name", help="The name of the library this model came from (Ex. pytorch, timm, spacy, keras, etc.)"
+        )
+        or None
+    )
+    tags = [
+        x.strip()
+        for x in st.text_input(
+            "Tags (comma separated)",
+            help="Additional tags to add which will be filterable on https://hf.co/models. (Ex. image-classification, vision, resnet)",
+        ).split(',')
+        if x.strip()
+    ] or None
+    dataset = (
+        st.text_input(
+            "Dataset", help="The dataset used to train this model. Use dataset id from https://hf.co/datasets"
+        )
+        or None
+    )
+    metrics = (
+        st.multiselect(
+            "Metrics",
+            available_metrics,
+            help="Metrics used in the training/evaluation of this model. Use metric id from https://hf.co/metrics.",
+        )
+        or None
+    )
+    model_description = st.text_area(
+        "Model Description",
+        "Describe your model here...",
+        help="The model description provides basic details about the model. This includes the architecture, version, if it was introduced in a paper, if an original implementation is available, the author, and general information about the model. Any copyright should be attributed here. General information about training procedures, parameters, and important disclaimers can also be mentioned in this section.",
+    )
+
+    do_warn = False
+    warning_msg = "Warning: The following fields are required but have not been filled in: "
+    if not languages:
+        warning_msg += "\n- Languages"
+        do_warn = True
+    if not license:
+        warning_msg += "\n- License"
+        do_warn = True
+
+    if do_warn:
+        warning_placeholder.warning(warning_msg)
+
+    card = ModelCard.from_template(
+        language=languages,
+        license=license_map[license],
+        library_name=library_name,
+        tags=tags,
+        datasets=dataset,
+        metrics=metrics,
+        model_id=model_name,
+        model_description=model_description,
+    )
+
+    placeholder.download_button(
+        label="Download Model Card", data=str(card), file_name='README.md', mime='text/plain', disabled=do_warn
+    )
+
+markdown_text = f"""
+Card metadata...this should be at the beginning of your readme file.
+
+```
+---
+{card.data.to_yaml()}
+---
+```
+
+{card.text}
+"""
+
+creation_code = f'''
+# Make sure you have modelcards installed!
+# pip install modelcards==0.0.4
+
+from modelcards import ModelCard
+
+card = ModelCard.from_template(
+    language={languages},
+    license={"'" + license_map[license] + "'" if license else None},
+    library_name={"'" + library_name + "'" if library_name else None},
+    tags={tags},
+    datasets={"'" + dataset + "'" if dataset else None},
+    metrics={metrics},
+    model_id={"'" + model_name + "'" if model_name else None},
+    model_description={"'" + model_description + "'" if model_description else None},
+)
+'''
+
+if view == 'Raw Text':
+    st.text(str(card))
+elif view == "Markdown":
+    st.markdown(markdown_text)
+else:
+    st.code(creation_code)