Upload README.md

README.md

@@ -13,38 +13,64 @@ license: mit
 - **License:** License for the model
 - **Model Description:** testing description
 
-## Intended uses & limitations
+## Intended Uses & Limitations
 
-You can use the model for 
+This model can be used for .
 
-#### How to use
+#### How to Use
+
+You can get started with the model with code like the following:
 
 ```python
 # You can include sample code which will be formatted
 ```
 
-#### Limitations and bias
+Here is how to use this model to get the features of a given text in Pytorch: 
+
+```python
+# PyTorch usage
+```
+
+and in TensorFlow: 
+
+```python
+# Tensorflow usage
+```
+
+#### Limitations and Bias
 
-Provide examples of latent issues and potential remediations.
+**CONTENT WARNING: Readers should be aware this section contains content that is disturbing, offensive, and can propogate historical and current stereotypes.**
 
-## Training data
+This model can have biased predictions. For example: 
+
+```python
+# Example of biased predictions
+```
+
+## Training Data
 
 Describe the data you used to train the model.
 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.
 
-## Training procedure
+## Training Procedure
 
 Preprocessing, hardware used, hyperparameters...
 
-## Eval results
+## Evaluation Results
 
 Provide some evaluation results.
 
 ## Environmental Impact
 
-You can estimate carbon emissions using the 
+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)
+
+- **Hardware Type:** 
+- **Hours used:** 
+- **Cloud Provider:** 
+- **Compute Region:** 
+- **Carbon Emitted** *(Power consumption x Time x Carbon produced based on location of power grid)*: 
 
-### BibTeX entry and citation info
+### BibTeX Entry and Citation Info
 
 ```bibtex
 @inproceedings{...,