nateraw commited on
Commit
92ac464
1 Parent(s): 3529397

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +61 -0
README.md ADDED
@@ -0,0 +1,61 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ language: en
3
+ license: mit
4
+ library_name: timm
5
+ tags:
6
+ - image-classification
7
+ - resnet
8
+ metrics:
9
+ - acc
10
+ - f1
11
+ model-index:
12
+ - name: my-cool-model-with-eval-results
13
+ results:
14
+ - task:
15
+ type: image-classification
16
+ dataset:
17
+ type: beans
18
+ name: Beans
19
+ metrics:
20
+ - type: accuracy
21
+ value: 0.9
22
+ ---
23
+
24
+ # my-cool-model-with-eval-results
25
+
26
+ ## Model description
27
+
28
+ This isn't really a model, it's just a test repo to see if the [modelcards](https://github.com/nateraw/modelcards) package works!
29
+
30
+ ## Intended uses & limitations
31
+
32
+ #### How to use
33
+
34
+ ```python
35
+ # You can include sample code which will be formatted
36
+ ```
37
+
38
+ #### Limitations and bias
39
+
40
+ Provide examples of latent issues and potential remediations.
41
+
42
+ ## Training data
43
+
44
+ Describe the data you used to train the model.
45
+ 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.
46
+
47
+ ## Training procedure
48
+
49
+ Preprocessing, hardware used, hyperparameters...
50
+
51
+ ## Eval results
52
+
53
+ Provide some evaluation results.
54
+
55
+ ### BibTeX entry and citation info
56
+
57
+ ```bibtex
58
+ @inproceedings{...,
59
+ year={2020}
60
+ }
61
+ ```