nateraw commited on
Commit
95904b3
1 Parent(s): b3d5a3d

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +55 -0
README.md ADDED
@@ -0,0 +1,55 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ language: en
3
+ license: mit
4
+ datasets: beans
5
+ model-index:
6
+ - name: my-cool-model-with-card-2
7
+ results:
8
+ - task:
9
+ type: image-classification
10
+ dataset:
11
+ type: beans
12
+ name: Beans
13
+ metrics:
14
+ - type: acc
15
+ value: 0.9
16
+ ---
17
+
18
+ # MyModelName
19
+
20
+ ## Model description
21
+
22
+ 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.
23
+
24
+ ## Intended uses & limitations
25
+
26
+ #### How to use
27
+
28
+ ```python
29
+ # You can include sample code which will be formatted
30
+ ```
31
+
32
+ #### Limitations and bias
33
+
34
+ Provide examples of latent issues and potential remediations.
35
+
36
+ ## Training data
37
+
38
+ Describe the data you used to train the model.
39
+ If you initialized it with pre-trained weights, add a link to the pre-trained model card or repository with description of the pre-training data.
40
+
41
+ ## Training procedure
42
+
43
+ Preprocessing, hardware used, hyperparameters...
44
+
45
+ ## Eval results
46
+
47
+ Provide some evaluation results.
48
+
49
+ ### BibTeX entry and citation info
50
+
51
+ ```bibtex
52
+ @inproceedings{...,
53
+ year={2020}
54
+ }
55
+ ```