Suru commited on
Commit
54857a3
1 Parent(s): fecc951

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +38 -0
README.md CHANGED
@@ -1,3 +1,41 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: apache-2.0
3
  ---
 
1
+ # Shakha Khel Assistant
2
+
3
+ ## Overview
4
+ Welcome to the Shakha Khel Assistant, your digital helper for planning various games (Khel) for your Shakha activities. This tool leverages the LLAMA 2 7B model to provide you with a wide range of game suggestions, tailored for the unique needs of HSS Shakha gatherings.
5
+
6
+ ## Features
7
+ - **Diverse Game Recommendations**: From individual pursuits to team challenges and games that require specific equipment or strategic thinking.
8
+ - **Culturally Relevant**: Suggestions are based on a dataset specific to HSS Shakha activities, ensuring appropriate and engaging selections.
9
+ - **Easy to Use**: Simply ask for the type of game you need, and receive a list of suggestions instantly.
10
+
11
+ ## Powered by Technology
12
+ 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.
13
+
14
+ ## Example Usage
15
+ Below is an example command to the Shakha Khel Assistant and its output:
16
+
17
+ ![Shakha Khel Assistant Example](path_to_your_image/khel_example.jpg)
18
+
19
+ *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.*
20
+
21
+ ## How to Use
22
+ To get game recommendations, you can use the following types of queries:
23
+ - "Recommend me three different types of individual pursuit games."
24
+ - "Suggest some team games that require minimal equipment."
25
+ - "List some thinking games for small groups."
26
+
27
+ ## Contributing
28
+ We appreciate contributions from the community! If you have game suggestions or improvements to the assistant, please feel free to contribute.
29
+
30
+ ## License
31
+ [Specify your license here, if applicable]
32
+
33
+ ## Contact
34
+ For any questions or feedback, please reach out to [Your Contact Information].
35
+
36
+ Enjoy planning your Shakha games with ease and creativity with Shakha Khel Assistant!
37
+
38
+
39
  ---
40
  license: apache-2.0
41
  ---