Upload README.md
Browse files
README.md
CHANGED
@@ -13,38 +13,64 @@ license: mit
|
|
13 |
- **License:** License for the model
|
14 |
- **Model Description:** testing description
|
15 |
|
16 |
-
## Intended
|
17 |
|
18 |
-
|
19 |
|
20 |
-
#### How to
|
|
|
|
|
21 |
|
22 |
```python
|
23 |
# You can include sample code which will be formatted
|
24 |
```
|
25 |
|
26 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
27 |
|
28 |
-
|
29 |
|
30 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
31 |
|
32 |
Describe the data you used to train the model.
|
33 |
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.
|
34 |
|
35 |
-
## Training
|
36 |
|
37 |
Preprocessing, hardware used, hyperparameters...
|
38 |
|
39 |
-
##
|
40 |
|
41 |
Provide some evaluation results.
|
42 |
|
43 |
## Environmental Impact
|
44 |
|
45 |
-
You can estimate carbon emissions using the
|
|
|
|
|
|
|
|
|
|
|
|
|
46 |
|
47 |
-
### BibTeX
|
48 |
|
49 |
```bibtex
|
50 |
@inproceedings{...,
|
|
|
13 |
- **License:** License for the model
|
14 |
- **Model Description:** testing description
|
15 |
|
16 |
+
## Intended Uses & Limitations
|
17 |
|
18 |
+
This model can be used for .
|
19 |
|
20 |
+
#### How to Use
|
21 |
+
|
22 |
+
You can get started with the model with code like the following:
|
23 |
|
24 |
```python
|
25 |
# You can include sample code which will be formatted
|
26 |
```
|
27 |
|
28 |
+
Here is how to use this model to get the features of a given text in Pytorch:
|
29 |
+
|
30 |
+
```python
|
31 |
+
# PyTorch usage
|
32 |
+
```
|
33 |
+
|
34 |
+
and in TensorFlow:
|
35 |
+
|
36 |
+
```python
|
37 |
+
# Tensorflow usage
|
38 |
+
```
|
39 |
+
|
40 |
+
#### Limitations and Bias
|
41 |
|
42 |
+
**CONTENT WARNING: Readers should be aware this section contains content that is disturbing, offensive, and can propogate historical and current stereotypes.**
|
43 |
|
44 |
+
This model can have biased predictions. For example:
|
45 |
+
|
46 |
+
```python
|
47 |
+
# Example of biased predictions
|
48 |
+
```
|
49 |
+
|
50 |
+
## Training Data
|
51 |
|
52 |
Describe the data you used to train the model.
|
53 |
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.
|
54 |
|
55 |
+
## Training Procedure
|
56 |
|
57 |
Preprocessing, hardware used, hyperparameters...
|
58 |
|
59 |
+
## Evaluation Results
|
60 |
|
61 |
Provide some evaluation results.
|
62 |
|
63 |
## Environmental Impact
|
64 |
|
65 |
+
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)
|
66 |
+
|
67 |
+
- **Hardware Type:**
|
68 |
+
- **Hours used:**
|
69 |
+
- **Cloud Provider:**
|
70 |
+
- **Compute Region:**
|
71 |
+
- **Carbon Emitted** *(Power consumption x Time x Carbon produced based on location of power grid)*:
|
72 |
|
73 |
+
### BibTeX Entry and Citation Info
|
74 |
|
75 |
```bibtex
|
76 |
@inproceedings{...,
|