Marc Tomlinson commited on
Commit
99618de
1 Parent(s): bb2d7e8

initial readme need to update

Browse files
Files changed (1) hide show
  1. README.md +54 -0
README.md ADDED
@@ -0,0 +1,54 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ language:
3
+ -
4
+ -
5
+ thumbnail:
6
+ tags:
7
+ -
8
+ -
9
+ -
10
+ license:
11
+ datasets:
12
+ -
13
+ -
14
+ metrics:
15
+ -
16
+ -
17
+ ---
18
+
19
+ # MyModelName
20
+
21
+ ## Model description
22
+
23
+ You can embed local or remote images using `![](...)`
24
+
25
+ ## Intended uses & limitations
26
+
27
+ #### How to use
28
+
29
+ ```python
30
+ # You can include sample code which will be formatted
31
+ ```
32
+
33
+ #### Limitations and bias
34
+
35
+ Provide examples of latent issues and potential remediations.
36
+
37
+ ## Training data
38
+
39
+ Describe the data you used to train the model.
40
+ 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.
41
+
42
+ ## Training procedure
43
+
44
+ Preprocessing, hardware used, hyperparameters...
45
+
46
+ ## Eval results
47
+
48
+ ### BibTeX entry and citation info
49
+
50
+ ```bibtex
51
+ @inproceedings{...,
52
+ year={2020}
53
+ }
54
+ ```