nateraw commited on
Commit
98bc8bf
·
1 Parent(s): b5a40f4

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +117 -0
README.md ADDED
@@ -0,0 +1,117 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ language:
3
+ - en
4
+ license: mit
5
+ tags:
6
+ - autogenerated-modelcard
7
+ ---
8
+
9
+ # modelcard-creator-demo
10
+
11
+ ## Table of Contents
12
+ - [Model Details](#model-details)
13
+ - [How To Get Started With the Model](#how-to-get-started-with-the-model)
14
+ - [Uses](#uses)
15
+ - [Direct Use](#direct-use)
16
+ - [Downstream Use](#downstream-use)
17
+ - [Misuse and Out of Scope Use](#misuse-and-out-of-scope-use)
18
+ - [Limitations and Biases](#limitations-and-biases)
19
+ - [Training](#training)
20
+ - [Training Data](#training-data)
21
+ - [Training Procedure](#training-procedure)
22
+ - [Evaluation Results](#evaluation-results)
23
+ - [Environmental Impact](#environmental-impact)
24
+ - [Licensing Information](#licensing-information)
25
+ - [Citation Information](#citation-information)
26
+
27
+
28
+ ## Model Details
29
+
30
+ <!-- Give an overview of your model, the relevant research paper, who trained it, etc. -->
31
+
32
+ This isn't really a model, it's just a test repo to see if the [model card creator](https://hf.co/spaces/nateraw/model-card-creator) works!
33
+
34
+
35
+ - Developed by:
36
+ - Language(s):
37
+ - License: modelcard-creator-demo is licensed under the mit license
38
+ - Resources for more information:
39
+
40
+
41
+
42
+
43
+ ## How to Get Started with the Model
44
+
45
+ Use the code below to get started with the model.
46
+
47
+ ```python
48
+ # A nice code snippet here that describes how to use the model...
49
+ ```
50
+
51
+ ## Uses
52
+
53
+ #### Direct Use
54
+
55
+ <!-- Describe what kind of tasks this model can be used for directly or problems it can solve. -->
56
+
57
+ [More Information Needed]
58
+
59
+ #### Downstream Use
60
+
61
+ <!-- Describe how this model could be leveraged by a downstream model (if applicable) -->
62
+
63
+ [More Information Needed]
64
+
65
+ #### Misuse and Out-of-scope Use
66
+
67
+ <!-- Describe ways in which this model ***should not*** be used. -->
68
+
69
+ [More Information Needed]
70
+
71
+ ## Limitations and Biases
72
+
73
+ <!-- Describe limitations and biases of this model or models of it's type. -->
74
+
75
+ **CONTENT WARNING: Readers should be aware this section contains content that is disturbing, offensive, and can propogate historical and current stereotypes.**
76
+
77
+ [More Information Needed]
78
+
79
+ ## Training
80
+
81
+ #### Training Data
82
+
83
+ <!-- Describe the dataset used to train this model. -->
84
+ <!-- Refer to data card if dataset is provided and exists on the hub -->
85
+
86
+ See the data card for additional information.
87
+
88
+ #### Training Procedure
89
+
90
+ <!-- Describe the preprocessing, hardware used, training hyperparameters, etc. -->
91
+
92
+ [More Information Needed]
93
+
94
+ ## Evaluation Results
95
+
96
+ <!-- Describe evaluation results of this model across any datasets it was evaluated on. -->
97
+
98
+ [More Information Needed]
99
+
100
+ ## Environmental Impact
101
+
102
+ <!-- Provide information to document the environmental impact of this model -->
103
+
104
+ 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)
105
+
106
+ - **Hardware Type:**
107
+ - **Hours used:**
108
+ - **Cloud Provider:**
109
+ - **Compute Region:**
110
+ - **Carbon Emitted:**
111
+
112
+
113
+ ## Citation Information
114
+
115
+ ```bibtex
116
+
117
+ ```