MattStammers commited on
Commit
aef6e93
·
1 Parent(s): 6eeefd5

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +42 -0
README.md ADDED
@@ -0,0 +1,42 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ {{card_data}}
3
+ ---
4
+
5
+ # {{ model_id | default("MyModelName", true)}}
6
+
7
+ ## Model description
8
+
9
+ {{ model_description | default("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.", true)}}
10
+
11
+ ## Intended uses & limitations
12
+
13
+ #### How to use
14
+
15
+ ```python
16
+ # You can include sample code which will be formatted
17
+ ```
18
+
19
+ #### Limitations and bias
20
+
21
+ Provide examples of latent issues and potential remediations.
22
+
23
+ ## Training data
24
+
25
+ Describe the data you used to train the model.
26
+ 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.
27
+
28
+ ## Training procedure
29
+
30
+ Preprocessing, hardware used, hyperparameters...
31
+
32
+ ## Eval results
33
+
34
+ Provide some evaluation results.
35
+
36
+ ### BibTeX entry and citation info
37
+
38
+ ```bibtex
39
+ @inproceedings{...,
40
+ year={2020}
41
+ }
42
+ ```