Update README.md
Browse files
README.md
CHANGED
|
@@ -14,15 +14,6 @@ Welcome to the Shakha Khel Assistant, your digital helper for planning various g
|
|
| 14 |
## Powered by Technology
|
| 15 |
The Shakha Khel Assistant uses the LLAMA 2 7B model, which has been trained on a dataset specifically curated from `Suru/HSS-shakha-khel`. This training ensures that the game recommendations are varied, engaging, and suitable for Shakha members of all ages.
|
| 16 |
|
| 17 |
-
## Example Usage
|
| 18 |
-
Below is an example command to the Shakha Khel Assistant and its output:
|
| 19 |
-
|
| 20 |
-
|
| 21 |
-
|
| 22 |
-
*In this example, the user has asked for three different team games and three different individual pursuit games, and the assistant has provided recommendations for each.*
|
| 23 |
-
|
| 24 |
-
NOTE: The instruction must be in alpaca format.Therefore we need to format the prompt accordingly. For more information, check out the article below!
|
| 25 |
-
|
| 26 |
## How to Use
|
| 27 |
-> We will make the model load in smaller bit precision (4 bit quantization) which allow us to use free colab gpu. Make sure that GPU is enabled under runtime settings. First install libraries
|
| 28 |
Downlaod the required libraries
|
|
@@ -48,10 +39,20 @@ To get game recommendations, you can use the following types of queries:
|
|
| 48 |
- "Recommend me three different types of individual pursuit games."
|
| 49 |
- "Suggest some team games that require minimal equipment."
|
| 50 |
- "List some thinking games for small mandal (groups)."
|
|
|
|
| 51 |
|
| 52 |
## You can get started using this model by using free Google Colab GPU! Check out the article below for more information.
|
| 53 |
[Run HSS Shakha Khel Assistant on Your Computer](https://medium.com/@suru10/run-hss-shakha-khel-assistant-on-your-computer-0a1c40a41d9a)
|
| 54 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 55 |
|
| 56 |
## Contributing
|
| 57 |
We appreciate contributions from the community! If you have game suggestions or improvements to the assistant, please feel free to contribute.
|
|
|
|
| 14 |
## Powered by Technology
|
| 15 |
The Shakha Khel Assistant uses the LLAMA 2 7B model, which has been trained on a dataset specifically curated from `Suru/HSS-shakha-khel`. This training ensures that the game recommendations are varied, engaging, and suitable for Shakha members of all ages.
|
| 16 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 17 |
## How to Use
|
| 18 |
-> We will make the model load in smaller bit precision (4 bit quantization) which allow us to use free colab gpu. Make sure that GPU is enabled under runtime settings. First install libraries
|
| 19 |
Downlaod the required libraries
|
|
|
|
| 39 |
- "Recommend me three different types of individual pursuit games."
|
| 40 |
- "Suggest some team games that require minimal equipment."
|
| 41 |
- "List some thinking games for small mandal (groups)."
|
| 42 |
+
- "Design a 'Surya Namaskar' theme khel using 'Pakado' khel."
|
| 43 |
|
| 44 |
## You can get started using this model by using free Google Colab GPU! Check out the article below for more information.
|
| 45 |
[Run HSS Shakha Khel Assistant on Your Computer](https://medium.com/@suru10/run-hss-shakha-khel-assistant-on-your-computer-0a1c40a41d9a)
|
| 46 |
|
| 47 |
+
## Example Usage
|
| 48 |
+
Below is an example command to the Shakha Khel Assistant and its output:
|
| 49 |
+
|
| 50 |
+
|
| 51 |
+
|
| 52 |
+
*In this example, the user has asked for three different team games and three different individual pursuit games, and the assistant has provided recommendations for each.*
|
| 53 |
+
|
| 54 |
+
NOTE: The instruction must be in alpaca format.Therefore we need to format the prompt accordingly. For more information, check out the article below!
|
| 55 |
+
|
| 56 |
|
| 57 |
## Contributing
|
| 58 |
We appreciate contributions from the community! If you have game suggestions or improvements to the assistant, please feel free to contribute.
|