Spaces:
Sleeping
Sleeping
Ezi Ozoani
commited on
Commit
•
b2c7a50
1
Parent(s):
449bb10
fixing
Browse files- 1_📝_form.py +2 -0
- __pycache__/middleMan.cpython-39.pyc +0 -0
- language_model_template1.md +2 -2
- middleMan.py +9 -2
- modelcard_template_new_spec.md +4 -1
- temp_uploaded_filed_Dir/modelcard_template_new_spec.md +0 -201
1_📝_form.py
CHANGED
@@ -147,6 +147,7 @@ def main():
|
|
147 |
"Model_cite": "",
|
148 |
"paper_url": "",
|
149 |
"github_url": "",
|
|
|
150 |
"bibtex_citation": "",
|
151 |
"APA_citation":"",
|
152 |
|
@@ -189,6 +190,7 @@ def main():
|
|
189 |
st.text_input("Author(s) (comma separated)", help="The authors who developed this model. If you trained this model, the author is you.", key=persist("the_authors"))
|
190 |
st.text_input("Related Research Paper", help="Research paper related to this model.", key=persist("paper_url"))
|
191 |
st.text_input("Related GitHub Repository", help="Link to a GitHub repository used in the development of this model", key=persist("github_url"))
|
|
|
192 |
st.text_area("Bibtex Citation", help="Bibtex citations for related work", key=persist("bibtex_citations"))
|
193 |
st.text_input("Carbon Emitted:", help="You can estimate carbon emissions using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700)", key=persist("Model_c02_emitted"))
|
194 |
|
|
|
147 |
"Model_cite": "",
|
148 |
"paper_url": "",
|
149 |
"github_url": "",
|
150 |
+
"blog_url":"",
|
151 |
"bibtex_citation": "",
|
152 |
"APA_citation":"",
|
153 |
|
|
|
190 |
st.text_input("Author(s) (comma separated)", help="The authors who developed this model. If you trained this model, the author is you.", key=persist("the_authors"))
|
191 |
st.text_input("Related Research Paper", help="Research paper related to this model.", key=persist("paper_url"))
|
192 |
st.text_input("Related GitHub Repository", help="Link to a GitHub repository used in the development of this model", key=persist("github_url"))
|
193 |
+
st.text_input("Related Blog Post", help="Link to a blog post related to this model.", key=persist("blog_url"))
|
194 |
st.text_area("Bibtex Citation", help="Bibtex citations for related work", key=persist("bibtex_citations"))
|
195 |
st.text_input("Carbon Emitted:", help="You can estimate carbon emissions using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700)", key=persist("Model_c02_emitted"))
|
196 |
|
__pycache__/middleMan.cpython-39.pyc
CHANGED
Binary files a/__pycache__/middleMan.cpython-39.pyc and b/__pycache__/middleMan.cpython-39.pyc differ
|
|
language_model_template1.md
CHANGED
@@ -136,10 +136,10 @@
|
|
136 |
- **Language(s) (NLP):** {{ language | join(', ') | default("More information needed", true)}}
|
137 |
- **License:** {{ license | default("More information needed", true)}}
|
138 |
- **Related Models:** {{ related_models | join(', ') | default("More information needed", true)}}
|
139 |
-
|
140 |
- **Resources for more information:** {{ more_resources | default("More information needed", true)}}
|
141 |
{{ " - [GitHub Repo]({0})".format(repo_link) if repo_link }}
|
142 |
-
{{ " - [Associated Paper]({0})".format(paper_link) if paper_link }}
|
143 |
{{ " - [Blog Post]({0})".format(blog_link) if blog_link }}
|
144 |
|
145 |
# Uses
|
|
|
136 |
- **Language(s) (NLP):** {{ language | join(', ') | default("More information needed", true)}}
|
137 |
- **License:** {{ license | default("More information needed", true)}}
|
138 |
- **Related Models:** {{ related_models | join(', ') | default("More information needed", true)}}
|
139 |
+
- **Parent Model:** {{ parent_model | default("More information needed", true)}}
|
140 |
- **Resources for more information:** {{ more_resources | default("More information needed", true)}}
|
141 |
{{ " - [GitHub Repo]({0})".format(repo_link) if repo_link }}
|
142 |
+
{{ " - [Associated Paper]({0})".format(paper_link) if paper_link }}
|
143 |
{{ " - [Blog Post]({0})".format(blog_link) if blog_link }}
|
144 |
|
145 |
# Uses
|
middleMan.py
CHANGED
@@ -19,8 +19,12 @@ def is_float(value):
|
|
19 |
def parse_into_jinja_markdown():
|
20 |
env = Environment(loader=FileSystemLoader('.'), autoescape=True)
|
21 |
temp = env.get_template(st.session_state.markdown_upload)
|
22 |
-
|
|
|
|
|
|
|
23 |
return (temp.render(model_id = st.session_state["model_name"],
|
|
|
24 |
the_model_description = st.session_state["model_description"],developers=st.session_state["Model_developers"],shared_by = st.session_state["shared_by"],license = st.session_state['license'],
|
25 |
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"],
|
26 |
bias_risks_limitations = st.session_state["Model_Limits_n_Risks"], bias_recommendations = st.session_state['Recommendations'],
|
@@ -33,7 +37,10 @@ def parse_into_jinja_markdown():
|
|
33 |
more_information = st.session_state['More_info'],
|
34 |
model_card_authors = st.session_state['the_authors'],
|
35 |
model_card_contact = st.session_state['Model_card_contact'],
|
36 |
-
get_started_code =st.session_state["Model_how_to"]
|
|
|
|
|
|
|
37 |
))
|
38 |
|
39 |
|
|
|
19 |
def parse_into_jinja_markdown():
|
20 |
env = Environment(loader=FileSystemLoader('.'), autoescape=True)
|
21 |
temp = env.get_template(st.session_state.markdown_upload)
|
22 |
+
# to add:
|
23 |
+
# - parent model
|
24 |
+
# to fix:
|
25 |
+
# citation on form: check box for bibtex or apa: then parse
|
26 |
return (temp.render(model_id = st.session_state["model_name"],
|
27 |
+
language = st.session_state["languages"],
|
28 |
the_model_description = st.session_state["model_description"],developers=st.session_state["Model_developers"],shared_by = st.session_state["shared_by"],license = st.session_state['license'],
|
29 |
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"],
|
30 |
bias_risks_limitations = st.session_state["Model_Limits_n_Risks"], bias_recommendations = st.session_state['Recommendations'],
|
|
|
37 |
more_information = st.session_state['More_info'],
|
38 |
model_card_authors = st.session_state['the_authors'],
|
39 |
model_card_contact = st.session_state['Model_card_contact'],
|
40 |
+
get_started_code =st.session_state["Model_how_to"],
|
41 |
+
repo_link = st.session_state["github_url"],
|
42 |
+
paper_link = st.session_state["paper_url"],
|
43 |
+
blog_link = st.session_state["blog_url"]
|
44 |
))
|
45 |
|
46 |
|
modelcard_template_new_spec.md
CHANGED
@@ -57,8 +57,11 @@
|
|
57 |
- **Language(s) (NLP):** {{ language | default("More information needed", true)}}
|
58 |
- **License:** {{ license | default("More information needed", true)}}
|
59 |
- **Related Models:** {{ related_models | default("More information needed", true)}}
|
60 |
-
|
61 |
- **Resources for more information:** {{ more_resources | default("More information needed", true)}}
|
|
|
|
|
|
|
62 |
|
63 |
# Uses
|
64 |
|
|
|
57 |
- **Language(s) (NLP):** {{ language | default("More information needed", true)}}
|
58 |
- **License:** {{ license | default("More information needed", true)}}
|
59 |
- **Related Models:** {{ related_models | default("More information needed", true)}}
|
60 |
+
- **Parent Model:** {{ parent_model | default("More information needed", true)}}
|
61 |
- **Resources for more information:** {{ more_resources | default("More information needed", true)}}
|
62 |
+
{{ " - [GitHub Repo]({0})".format(repo_link) if repo_link }}
|
63 |
+
{{ " - [Associated Paper]({0})".format(paper_link) if paper_link }}
|
64 |
+
{{ " - [Blog Post]({0})".format(blog_link) if blog_link }}
|
65 |
|
66 |
# Uses
|
67 |
|
temp_uploaded_filed_Dir/modelcard_template_new_spec.md
DELETED
@@ -1,201 +0,0 @@
|
|
1 |
-
---
|
2 |
-
{{card_data}}
|
3 |
-
---
|
4 |
-
|
5 |
-
# {{ model_id }}
|
6 |
-
|
7 |
-
<!--> Provide a quick summary of what the model is/does. <!-->
|
8 |
-
|
9 |
-
# Table of Contents
|
10 |
-
|
11 |
-
1. [Model Details](#model-details)
|
12 |
-
2. [Uses](#uses)
|
13 |
-
3. [Bias, Risks, and Limitations](#bias-risks-and-limitations)
|
14 |
-
4. [Training Details](#training-details)
|
15 |
-
5. [Evaluation](#evaluation)
|
16 |
-
6. [Model Examination](#model-examination)
|
17 |
-
7. [Environmental Impact](#environmental-impact)
|
18 |
-
8. [Technical Specifications](#technical-specifications-optional)
|
19 |
-
9. [Citation](#citation)
|
20 |
-
10. [Glossary](#glossary-optional)
|
21 |
-
11. [More Information](#more-information-optional)
|
22 |
-
12. [Model Card Authors](#model-card-authors-optional)
|
23 |
-
13. [Model Card Contact](#model-card-contact)
|
24 |
-
14. [How To Get Started With the Model](#how-to-get-started-with-the-model)
|
25 |
-
|
26 |
-
|
27 |
-
# Model Details
|
28 |
-
|
29 |
-
## Model Description
|
30 |
-
|
31 |
-
<!--> Provide a longer summary of what this model is. <!-->
|
32 |
-
|
33 |
-
- **Developed by:** {{ developers | default("More information needed", true)}}
|
34 |
-
- **Shared by [Optional]:** {{ shared_by | default("More information needed", true)}}
|
35 |
-
- **Model type:** Language model
|
36 |
-
- **Language(s) (NLP):** {{ language | default("More information needed", true)}}
|
37 |
-
- **License:** {{ license | default("More information needed", true)}}
|
38 |
-
- **Related Models:** {{ related_models | default("More information needed", true)}}
|
39 |
-
- **Parent Model:** {{ parent_model | default("More information needed", true)}}
|
40 |
-
- **Resources for more information:** {{ more_resources | default("More information needed", true)}}
|
41 |
-
|
42 |
-
# Uses
|
43 |
-
|
44 |
-
<!--> Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. <!-->
|
45 |
-
|
46 |
-
## Direct Use
|
47 |
-
|
48 |
-
<!--> This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. <!-->
|
49 |
-
|
50 |
-
{{ direct_use | default("More information needed", true)}}
|
51 |
-
|
52 |
-
## Downstream Use [Optional]
|
53 |
-
|
54 |
-
<!--> This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app <!-->
|
55 |
-
|
56 |
-
{{ downstream_use | default("More information needed", true)}}
|
57 |
-
|
58 |
-
## Out-of-Scope Use
|
59 |
-
|
60 |
-
<!--> This section addresses misuse, malicious use, and uses that the model will not work well for. <!-->
|
61 |
-
|
62 |
-
{{ out_of_scope_use | default("More information needed", true)}}
|
63 |
-
|
64 |
-
# Bias, Risks, and Limitations
|
65 |
-
|
66 |
-
<!--> This section is meant to convey both technical and sociotechnical limitations. <!-->
|
67 |
-
|
68 |
-
{{ bias_risks_limitations | default("More information needed", true)}}
|
69 |
-
|
70 |
-
## Recommendations
|
71 |
-
|
72 |
-
<!--> This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. <!-->
|
73 |
-
|
74 |
-
{{ bias_recommendations | default("Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recomendations.", true)}}
|
75 |
-
|
76 |
-
# Training Details
|
77 |
-
|
78 |
-
## Training Data
|
79 |
-
|
80 |
-
<!--> This should link to a Data Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. <!-->
|
81 |
-
|
82 |
-
{{ training_data | default("More information needed", true)}}
|
83 |
-
|
84 |
-
## Training Procedure
|
85 |
-
|
86 |
-
<!--> This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. <!-->
|
87 |
-
|
88 |
-
### Preprocessing
|
89 |
-
|
90 |
-
{{ preprocessing | default("More information needed", true)}}
|
91 |
-
|
92 |
-
### Speeds, Sizes, Times
|
93 |
-
|
94 |
-
<!--> This section provides information about throughput, start/end time, checkpoint size if relevant, etc. <!-->
|
95 |
-
|
96 |
-
{{ speeds_sizes_times | default("More information needed", true)}}
|
97 |
-
|
98 |
-
# Evaluation
|
99 |
-
|
100 |
-
<!--> This section describes the evaluation protocols and provides the results. <!-->
|
101 |
-
|
102 |
-
## Testing Data, Factors & Metrics
|
103 |
-
|
104 |
-
### Testing Data
|
105 |
-
|
106 |
-
<!--> This should link to a Data Card if possible. <!-->
|
107 |
-
|
108 |
-
{{ testing_data | default("More information needed", true)}}
|
109 |
-
|
110 |
-
### Factors
|
111 |
-
|
112 |
-
<!--> These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. <!-->
|
113 |
-
|
114 |
-
{{ testing_factors | default("More information needed", true)}}
|
115 |
-
|
116 |
-
### Metrics
|
117 |
-
|
118 |
-
<!--> These are the evaluation metrics being used, ideally with a description of why. <!-->
|
119 |
-
|
120 |
-
{{ testing_metrics | default("More information needed", true)}}
|
121 |
-
|
122 |
-
## Results
|
123 |
-
|
124 |
-
{{ results | default("More information needed", true)}}
|
125 |
-
|
126 |
-
# Model Examination
|
127 |
-
|
128 |
-
{{ model_examination | default("More information needed", true)}}
|
129 |
-
|
130 |
-
# Environmental Impact
|
131 |
-
|
132 |
-
<!--> Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly <!-->
|
133 |
-
|
134 |
-
Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
|
135 |
-
|
136 |
-
- **Hardware Type:** {{ hardware | default("More information needed", true)}}
|
137 |
-
- **Hours used:** {{ hours_used | default("More information needed", true)}}
|
138 |
-
- **Cloud Provider:** {{ cloud_provider | default("More information needed", true)}}
|
139 |
-
- **Compute Region:** {{ cloud_region | default("More information needed", true)}}
|
140 |
-
- **Carbon Emitted:** {{ co2_emitted | default("More information needed", true)}}
|
141 |
-
|
142 |
-
# Technical Specifications [optional]
|
143 |
-
|
144 |
-
## Model Architecture and Objective
|
145 |
-
|
146 |
-
{{ model_specs | default("More information needed", true)}}
|
147 |
-
|
148 |
-
## Compute Infrastructure
|
149 |
-
|
150 |
-
{{ compute_infrastructure | default("More information needed", true)}}
|
151 |
-
|
152 |
-
### Hardware
|
153 |
-
|
154 |
-
{{ hardware | default("More information needed", true)}}
|
155 |
-
|
156 |
-
### Software
|
157 |
-
|
158 |
-
{{ software | default("More information needed", true)}}
|
159 |
-
|
160 |
-
# Citation
|
161 |
-
|
162 |
-
<!--> A. <!-->
|
163 |
-
|
164 |
-
**BibTeX:**
|
165 |
-
|
166 |
-
{{ citation_bibtex | default("More information needed", true)}}
|
167 |
-
|
168 |
-
**APA:**
|
169 |
-
|
170 |
-
{{ citation_apa | default("More information needed", true)}}
|
171 |
-
|
172 |
-
# Glossary [optional]
|
173 |
-
|
174 |
-
<!--> If relevant, include terms and calculations in this section that can help readers understand the model or model card. <!-->
|
175 |
-
|
176 |
-
{{ glossary | default("More information needed", true)}}
|
177 |
-
|
178 |
-
# More Information [optional]
|
179 |
-
|
180 |
-
{{ more_information | default("More information needed", true)}}
|
181 |
-
|
182 |
-
# Model Card Authors [optional]
|
183 |
-
|
184 |
-
{{ model_card_authors | default("More information needed", true)}}
|
185 |
-
|
186 |
-
# Model Card Contact
|
187 |
-
|
188 |
-
{{ model_card_contact | default("More information needed", true)}}
|
189 |
-
|
190 |
-
# How to Get Started with the Model
|
191 |
-
|
192 |
-
Use the code below to get started with the model.
|
193 |
-
|
194 |
-
<details>
|
195 |
-
<summary> Click to expand </summary>
|
196 |
-
|
197 |
-
{{ get_started_code | default("More information needed", true)}}
|
198 |
-
|
199 |
-
</details>
|
200 |
-
|
201 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|