Update README.md

README.md

@@ -27,52 +27,41 @@ It also uses a different ouput layer consisting of sigmoid activated neurons to
 - **Language(s) (NLP):** Probably english (it depends heavily on dataset)
 - **License:** Apache license 2.0
 
-### Model Sources [optional]
-
-<!-- Provide the basic links for the model. -->
-
-- **Repository:** [More Information Needed]
 
 ## Uses
 
 <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-
+This can be used for text generation tasks where running large computationally intensive architectures are not applicable
 
 ### Direct Use
 
 <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+For simpler text generation tasks where long range contextual understanding is not must
 
-[More Information Needed]
-
-### Downstream Use [optional]
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-[More Information Needed]
 
 ### Out-of-Scope Use
 
 <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
 
-[More Information Needed]
+Not applicable for production/commercial use
+May generate illegal/bad/meaningless responses thay maybe harmful
 
 ## Bias, Risks, and Limitations
 
 <!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
+May generate illegal/bad/meaningless responses thay maybe harmful.
+The model can't handle longer sequences larger than 50 words with contextual relevence
 
 ### Recommendations
 
 <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
+May generate illegal/bad/meaningless responses thay maybe harmful
 
 ## How to Get Started with the Model
 
-Use the code below to get started with the model.
+Just run the main.py file
 
-[More Information Needed]
+almost basic documentation will be in program itself detailed manual will be in manual.txt file
 
 ## Training Details
 
@@ -85,11 +74,8 @@ Use the code below to get started with the model.
 ### Training Procedure
 
 <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
+Final training loss: 0.0322
+Final validation loss: 5.6888
 
 #### Training Hyperparameters
 
@@ -145,7 +131,7 @@ Use the code below to get started with the model.
 
 Carbon emissions can be estimated 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:** [More Information Needed]
+- **Hardware Type:** Trained using Nvidia rtx 2050, using cudnn and cuda dependencies
 - **Hours used:** [More Information Needed]
 - **Cloud Provider:** [More Information Needed]
 - **Compute Region:** [More Information Needed]
@@ -163,11 +149,11 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 #### Hardware
 
-[More Information Needed]
+Nvidia Geforce rtx 2050
 
 #### Software
 
-[More Information Needed]
+cudnn, cuda, tensorflow
 
 ## Citation [optional]