Update README.md

README.md

@@ -4,7 +4,7 @@ GPT3-like T5 model trained to generate text in multiple languages.
 
 ## Motivation
 
-- GPT models are expensive run.
+- GPT models are expensive to run.
 - GPT models are monolingual.
 
 ## Solution
@@ -15,7 +15,23 @@ GPT3-like T5 model trained to generate text in multiple languages.
 I fine-tuned T5 on multiple languages (🇬🇧 English, 🇩🇪 German, 🇫🇷 French) and multiple academic text snippets from
 various domains like tech, law, finance and science etc. to generate text, just like GPT models do.
 
-## Usage
+## Usage - [NLPlayStore](https://github.com/flexudy/NLPlayStore)👈
+
+```python
+from store.service_management import ServiceManager
+
+service_manager = ServiceManager().get_service("cheapity3")
+
+service.install()
+
+service = service.launch()
+
+input_text = "The mechanical engineering field requires an understanding of core areas including mechanics, dynamics, thermodynamics, materials science, structural analysis, and electricity."
+
+generated_texts = service.play(input_text, 15)
+```
+
+## Usage - Hugging Face Transformers 🤗
 
 - Provide some text e.g `"Italy, officially the Italian Republic is a country consisting of"`
 - Tell Cheapity3 how many words you want to generate e.g `15` -- 😃 Yes, you can control the length.
@@ -50,17 +66,19 @@ outputs = model.generate(
 
 for i in range(4):
     print(tokenizer.decode(outputs[i], skip_special_tokens=True, clean_up_tokenization_spaces=True))
+```
 
-# INPUT: The mechanical engineering field requires an understanding of core areas including mechanics, dynamics, thermodynamics, materials science, structural analysis, and electricity.
+**INPUT: The mechanical engineering field requires an understanding of core areas including mechanics, dynamics, thermodynamics, materials science, structural analysis, and electricity.**
 
-# > Cheapity3 continues with beam search:
-# ... The field of mechanical engineering is a broad field that includes many core areas of engineering.
+```
+> Cheapity3 continues with beam search:
+... The field of mechanical engineering is a broad field that includes many core areas of engineering.
  
-# > Cheapity3 continues with sampling and top_k=50:
-# ... Developing the knowledge base for these core areas will enable engineers to build their capabilities rapidly and efficiently. ...
-# ... The field of mechanics offers a variety and broad range for applications throughout the engineering/technological fields. ...
-# ... Mechanics generally is not understood by students. While they can be employed in the field, mechanical engineering ...
-# ... Introduction to mechanical engineering and core fields including chemical products, materials science, structural analysis, and geomatics ...
+> Cheapity3 continues with sampling and top_k=50:
+... Developing the knowledge base for these core areas will enable engineers to build their capabilities rapidly and efficiently. ...
+... The field of mechanics offers a variety and broad range for applications throughout the engineering/technological fields. ...
+... Mechanics generally is not understood by students. While they can be employed in the field, mechanical engineering ...
+... Introduction to mechanical engineering and core fields including chemical products, materials science, structural analysis, and geomatics ...
 ```
 
 ## Pretty decent right?
@@ -69,9 +87,9 @@ Hence, whenever you feel like GPT3 is too expensive, Cheapity3 comes to the resc
 
 ## Model Training FYI
 - T5-base model
-- Trained on only 1M sentences from English, French and German text
-- Mostly text from wikipedia, arxiv and QA datasets
+- Trained on ONLY 1M sentences from English, French and German text
+- Mostly text from Wikipedia, arxiv and QA datasets
 - Learning rate: 0.00003
 - 2 epochs
 - Max input: 512 tokens
-- Max output: 128 tokens
+- Max output: 128 tokens