let the batch patching begin: fixing (i) and textual information

1_📝_form.py

@@ -109,6 +109,7 @@ def main():
             "model_description": "Some cool model...",
             "shared_by": "",
             "the_authors":"",
+            "Shared_by":"",
             "Model_details_text": "",
             "Model_developers": "",
             "blog_url":"",
@@ -176,10 +177,10 @@ def main():
 
     st.text_input("Model Name", key=persist("model_name"))
     st.text_area("Model Description", 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.", key=persist('model_description'))
-    st.multiselect("Language(s)", list(languages_map), 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.", key=persist("languages"))
+    st.multiselect("Language(s)", list(languages_map), 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 language that is used in the dataset. For instance, if the dataset's labels are in english, you should select English here.", key=persist("languages"))
     st.selectbox("License", [""] + list(license_map.values()), help="The license associated with this model.", key=persist("license"))
     st.selectbox("Library Name", [""] + libraries, help="The name of the library this model came from (Ex. pytorch, timm, spacy, keras, etc.). This is usually automatically detected in model repos, so it is not required.", key=persist('library_name'))
-    st.text_input(" Parent Model (URL)", help="Please provide the URL link to the parent model", key=persist("Parent_Model_name"))
+    st.text_input("Parent Model (URL)", help="If this model has another model as its base, please provide the URL link to the parent model", key=persist("Parent_Model_name"))
     st.text_input("Datasets (comma separated)", help="The dataset(s) used to train this model. Use dataset id from https://hf.co/datasets.", key=persist("datasets"))
     st.multiselect("Metrics", available_metrics, help="Metrics used in the training/evaluation of this model. Use metric id from https://hf.co/metrics.", key=persist("metrics"))
     st.selectbox("Task", [""] + tasks, help="What task does this model aim to solve?", key=persist('task'))

current_card.md

@@ -48,7 +48,7 @@
 
 ## Model Description
 
-<!--> Provide a longer summary of what this model is. <!-->
+<!--> This section provides basic information about what the model is, its current status, and where it came from.. <!-->
 {{ the_model_description | default("More information needed", true)}}
 
 - **Developed by:** {{ developers | default("More information needed", true)}}

middleMan.py

@@ -25,7 +25,7 @@ def parse_into_jinja_markdown():
         # citation on form: check box for bibtex or apa: then parse 
     return (temp.render(model_id = st.session_state["model_name"],
         language = st.session_state["languages"],
-        the_model_description = st.session_state["model_description"],developers=st.session_state["Model_developers"],shared_by = st.session_state["shared_by"],model_license = st.session_state['license'],
+        the_model_description = st.session_state["model_description"],developers=st.session_state["Model_developers"],shared_by = st.session_state["Shared_by"],model_license = st.session_state['license'],
         parent_model_link = st.session_state['Parent_Model_url'],
             direct_use = st.session_state["Direct_Use"], downstream_use = st.session_state["Downstream_Use"],out_of_scope_use = st.session_state["Out-of-Scope_Use"],
             bias_risks_limitations = st.session_state["Model_Limits_n_Risks"], bias_recommendations = st.session_state['Recommendations'],

pages/11_ 📬_Model_Card_Contact.py

@@ -14,7 +14,7 @@ def main():
 def cs_body():
     
     st.markdown('# Model Card Contact')
-    st.text_area("Mediums to use, in order to contact the model creators.", key=persist("Model_card_contact"), )
+    st.text_area("How can people who have updates to the Model Card contact the authors?", key=persist("Model_card_contact"), )
 
         
    

pages/12_👩‍💻_How_To_Get_Started.py

@@ -21,7 +21,7 @@ def cs_body():
     
     st.markdown('# How to Get Started with the Model')
     st.session_state['Model_how_to'] = text_pass
-    st.text_area("Include relevant terms and calculations in this section that can help readers understand the model or model card.",height = 300, key=persist("Model_how_to"))
+    st.text_area("Code snippet to show how to use the model.",height = 300, key=persist("Model_how_to"))
    
         
 

pages/13_🔖_Model_Card_Authors.py

@@ -16,7 +16,7 @@ def cs_body():
     #card.save('current_editable.md')
     
     st.markdown('# Model Card Authors [optional]')
-    st.text_area("This section provides another layer of transparency and accountability. Whose views is this model card representing? How many voices were included in its construction? Etc.",height = 180, key=persist("the_authors"))
+    st.text_area("This section also provides another layer of transparency and accountability. Whose views is this model card representing? How many voices were included in its construction? Etc.",height = 180, help = "The people who actually constructed the Model Card go here.",key=persist("the_authors"))
     
     
     

pages/14_📚_Glossary.py

@@ -12,7 +12,7 @@ def main():
 def cs_body():
 
     st.markdown('# Glossary [optional]')
-    st.text_area("Include relevant terms and calculations in this section that can help readers understand the model or model card.",height = 200, key=persist("Glossary"))
+    st.text_area("Terms used in the model card that need to be clearly defined in order to be accessible across audiences go here.",height = 200, key=persist("Glossary"))
    
         
         

pages/2_📜_Model_Details.py

@@ -60,11 +60,11 @@ def cs_body():
             st.markdown('### Model Type:')
             
         with right:
-            st.text_input("",help="Developed By work", key=persist("Model_developers"))
+            st.text_input("",help="List the people who built the model.", key=persist("Model_developers"))
             st.write("\n")
-            st.text_input("",help="Shared By work",key=persist("shared_by"))
+            st.text_input("",help="List the people/organization making the model available online.",key=persist("Shared_by"))
             st.write("\n")
-            st.selectbox("",[""] + list(license_map.values()), help="Licenses work", key=persist("license"))
+            st.selectbox("",[""] + list(license_map.values()), help="The license associated with this model.", key=persist("license"))
         
     with st.container():
         

pages/3_ 🏗_Uses.py

@@ -10,7 +10,7 @@ def main():
 def cs_body():
     
     st.markdown('# Uses')
-    st.text_area("Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model",help="Model uses large work")
+    st.text_area("This section addresses questions around how the model is intended to be used, discusses the foreseeable users of the model (including those affected by the model), and describes uses that are considered out of scope or misuse of the model.")
     left, right = st.columns([2,4])
     
     #st.markdown('### Model Description')
@@ -35,9 +35,9 @@ def cs_body():
         st.markdown('### Out-of-Scope Use:')
         
     with right:
-        st.text_area("",help="This section is for the model use without fine-tuning or plugging into a larger ecosystem/app.", key=persist("Direct_Use"))
-        st.text_area("",help="This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/ap",key=persist("Downstream_Use"))
-        st.text_area("", help=" This section addresses misuse, malicious use, and uses that the model will not work well for.", key=persist("Out-of-Scope_Use"))
+        st.text_area("",help="How can this model be used, without additional post-processing or further pipeline work?", key=persist("Direct_Use"))
+        st.text_area("",help="How can this model be used, when incorporated into another system?",key=persist("Downstream_Use"))
+        st.text_area("", help="What tasks will the model not work for?", key=persist("Out-of-Scope_Use"))
 
    
     

pages/4_⚠️_Limits_and_Risks.py

@@ -11,7 +11,7 @@ def main():
 def cs_body():
     
     st.markdown('# Bias, Risks, and Limitations')
-    st.text_area("Use this section to convey both technical and sociotechnical limitations",help="Provide an overview of the possible Limitations and Risks that may be associated with this model", key=persist("Model_Limits_n_Risks"), )
+    st.text_area("What are the known or foreseeable issues stemming from this model? Use this section to convey both technical and sociotechnical limitations",help="Provide an overview of the possible Limitations and Risks that may be associated with this model", key=persist("Model_Limits_n_Risks"), )
     left, right = st.columns([2,4])
     
     #st.markdown('### Model Description')
@@ -25,7 +25,7 @@ def cs_body():
         
     with right:
         #soutput_jinja = parse_into_jinja_markdown()
-        st.text_area("",help="This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. ", key=persist("Recommendations"))
+        st.text_area("",help="How can the known or foreseeable issues be addressed?", key=persist("Recommendations"))
         #st.write("\n")
   
     

pages/5_🏋️‍♀️_Model_training.py

@@ -60,7 +60,7 @@ def cs_body():
     with right:
         #soutput_jinja = parse_into_jinja_markdown()
         
-        st.text_area("", key=persist("training_Data"))
+        st.text_area("", help ="Ideally this links to a Dataset Card.", key=persist("training_Data"))
         #st.write("\n")
         st.write("\n")
         st.write("\n")
@@ -74,7 +74,7 @@ def cs_body():
         st.write("\n")
         st.write("\n")
         
-        st.text_area("", key=persist("model_preprocessing"))
+        st.text_area("",key=persist("model_preprocessing"))
         st.text_area("", help = "This section provides information about throughput, start/end time, checkpoint size if relevant, etc.", key=persist("Speeds_Sizes_Times"))
    
    

pages/6_🔬_Model_Evaluation.py

@@ -51,10 +51,10 @@ def cs_body():
         
     with right:
         #soutput_jinja = parse_into_jinja_markdown()
-        st.text_area("", key=persist("Testing_Data"))
+        st.text_area("", help="Ideally this links to a Dataset Card.",key=persist("Testing_Data"))
         #st.write("\n")
-        st.text_area("",help="These are the things the evaluation is disaggregating by, e.g., subpopulations or domains.",key=persist("Factors"))
-        st.text_area("", help=" These are the evaluation metrics being used, ideally with a description of why.", key=persist("Metrics"))
+        st.text_area("",help="What are the foreseeable characteristics that will influence how the model behaves? This includes domain and context, as well as population subgroups.",key=persist("Factors"))
+        st.text_area("", help="What metrics will be used for evaluation in light of tradeoffs between different errors?", key=persist("Metrics"))
         st.text_area("", key=persist("Model_Results"))
 
    

pages/7_🔎_Model_Examination.py

@@ -18,7 +18,7 @@ def cs_body():
     #help_text = 'Give an overview of your model, the relevant research paper, who trained it, etc.'
 
     st.markdown('# Model Examination')
-    st.text_area("Provide an overview of your model, the relevant research paper, who trained it, etc",height = 200, key=persist("Model_examin"), )
+    st.text_area("Experimental: Where explainability/interpretability work can go.",height = 200, key=persist("Model_examin"), )
     #left, right = st.columns([2,4], gap="small")
     
     #st.markdown('### Model Description')