Update README.md

README.md

@@ -1,3 +1,4 @@
+```md
 ---
 language:
 - en
@@ -10,130 +11,59 @@ tags:
 
 ---
 
-# Uploaded  model
+# Uploaded Model
 
 - **Developed by:** ar08
 - **License:** apache-2.0
-# USAGE
-```python
----
-language:
-- en
-license: apache-2.0
-tags:
-- text-generation-inference
-- transformers
-- llama
-- gguf
-
----
-
-# Uploaded  model
-
-- **Developed by:** ar08
-- **License:** apache-2.0
-# USAGE
-```python
-#pip install llama-cpp-python
-# Install transformers from source - only needed for versions <= v4.34
-# pip install git+https://github.com/huggingface/transformers.git
-# pip install accelerate
-# Instanciate the model
-from llama_cpp import Llama
-
-my_aweseome_llama_model = Llama(model_path="./MY_AWESOME_MODEL")
-
-
-prompt = "This is a prompt"
-max_tokens = 100
-temperature = 0.3
-top_p = 0.1
-echo = True
-stop = ["Q", "\n"]
-
-
-# Define the parameters
-model_output = my_aweseome_llama_model(
-       prompt,
-       max_tokens=max_tokens,
-       temperature=temperature,
-       top_p=top_p,
-       echo=echo,
-       stop=stop,
-   )
-final_result = model_output["choices"][0]["text"].strip()
-from llama_cpp import Llama
-
-
-# GLOBAL VARIABLES
-my_model_path = "your dowloaded model name/path"
-CONTEXT_SIZE = 512
-
-
-# LOAD THE MODEL
-model = Llama(model_path=my_model_path,
-                    n_ctx=CONTEXT_SIZE)
-def generate_text_from_prompt(user_prompt,
-                             max_tokens = 100,
-                             temperature = 0.3,
-                             top_p = 0.1,
-                             echo = True,
-                             stop = ["Q", "\n"]):
-
-
-
-
-   # Define the parameters
-   model_output = zephyr_model(
-       user_prompt,
-       max_tokens=max_tokens,
-       temperature=temperature,
-       top_p=top_p,
-       echo=echo,
-       stop=stop,
-   )
-
 
-   return model_output
+## USAGE
 
-if __name__ == "__main__":
+To use this model, follow the steps below:
 
+1. **Install the necessary packages:**
+   ```python
+   # Install llama-cpp-python
+   pip install llama-cpp-python
 
-   my_prompt = "What do you think about the inclusion policies in Tech companies?"
+   # Install transformers from source - only needed for versions <= v4.34
+   pip install git+https://github.com/huggingface/transformers.git
 
+   # Install accelerate
+   pip install accelerate
+   ```
 
-   model_response = generate_text_from_prompt(my_prompt)
+2. **Instantiate the model:**
+   ```python
+   from llama_cpp import Llama
 
+   # Define the model path
+   my_model_path = "your_downloaded_model_name/path"
+   CONTEXT_SIZE = 512
 
-   print(model_response)
-```
-# Chat tempalte:
-```
-"instruction":"Summarize the given article in 200 Words.",
-"input": "https://www.bbc.com/news/world-51461830",
-"output": "The recent protests in Belarus are part of a growing wave of discontent against the rule of Alexander Lukashenko, who has led the country since 1994. Demonstrations against his government have been ongoing since August, and come in the wake of an election widely seen as rigged. As police and security forces have cracked down on protesters, the movement has only grown, with hundreds of thousands of people taking to the streets to call for new leadership. Human rights activists have accused the government of using extreme violence in order prosecute protesters, leading to an international outcry and sanctions from the European Union. As the situation in Belarus continues to unfold, the international community is monitoring the situation closely - hoping for a peaceful resolution, while also standing firm against the oppressive tactics employed by the Belarusian state."
+   # Load the model
+   model = Llama(model_path=my_model_path, n_ctx=CONTEXT_SIZE)
+   ```
 
-"instruction": "Classify the following shape according to simple geometry.",
-"input": "<Picture Attached>",
-"output": "Triangle"
+3. **Generate text from a prompt:**
+   ```python
+   def generate_text_from_prompt(user_prompt, max_tokens=100, temperature=0.3, top_p=0.1, echo=True, stop=["Q", "\n"]):
+       # Define the parameters
+       model_output = model(
+           user_prompt,
+           max_tokens=max_tokens,
+           temperature=temperature,
+           top_p=top_p,
+           echo=echo,
+           stop=stop,
+       )
 
-"instruction": "Given a recent news article, write a headline for it.",
-"input": "https://www.news.example.com/article-1",
-"output": "\"NASA Launches a Mars 2020 Mission to Search for Signs of Ancient Life\""
-```
+       return model_output["choices"][0]["text"].strip()
 
-```
-# Chat tempalte:
-```
-"instruction":"Summarize the given article in 200 Words.",
-"input": "https://www.bbc.com/news/world-51461830",
-"output": "The recent protests in Belarus are part of a growing wave of discontent against the rule of Alexander Lukashenko, who has led the country since 1994. Demonstrations against his government have been ongoing since August, and come in the wake of an election widely seen as rigged. As police and security forces have cracked down on protesters, the movement has only grown, with hundreds of thousands of people taking to the streets to call for new leadership. Human rights activists have accused the government of using extreme violence in order prosecute protesters, leading to an international outcry and sanctions from the European Union. As the situation in Belarus continues to unfold, the international community is monitoring the situation closely - hoping for a peaceful resolution, while also standing firm against the oppressive tactics employed by the Belarusian state."
+   if __name__ == "__main__":
+       my_prompt = "What do you think about the inclusion policies in Tech companies?"
+       model_response = generate_text_from_prompt(my_prompt)
+       print(model_response)
+   ```
 
-"instruction": "Classify the following shape according to simple geometry.",
-"input": "<Picture Attached>",
-"output": "Triangle"
 
-"instruction": "Given a recent news article, write a headline for it.",
-"input": "https://www.news.example.com/article-1",
-"output": "\"NASA Launches a Mars 2020 Mission to Search for Signs of Ancient Life\""
-```
+```