talhasideline commited on
Commit
2dffde8
Β·
verified Β·
1 Parent(s): 42e38aa

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +40 -6
README.md CHANGED
@@ -1,13 +1,47 @@
1
  ---
2
- title: Hockey Chatbot
3
- emoji: πŸ’¬
4
- colorFrom: yellow
5
- colorTo: purple
6
  sdk: gradio
7
- sdk_version: 5.0.1
8
  app_file: app.py
9
  pinned: false
10
  license: mit
11
  ---
12
 
13
- An example chatbot using [Gradio](https://gradio.app), [`huggingface_hub`](https://huggingface.co/docs/huggingface_hub/v0.22.2/en/index), and the [Hugging Face Inference API](https://huggingface.co/docs/api-inference/index).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: Hockey Mind AI Chatbot
3
+ emoji: πŸ’
4
+ colorFrom: green
5
+ colorTo: blue
6
  sdk: gradio
7
+ sdk_version: 4.8.0
8
  app_file: app.py
9
  pinned: false
10
  license: mit
11
  ---
12
 
13
+ # πŸ’ Hockey Mind AI Chatbot
14
+
15
+ An intelligent field hockey coaching assistant that provides personalized advice, training recommendations, and video content suggestions.
16
+
17
+ ## Features
18
+
19
+ - **Multilingual Support**: English and Dutch language support
20
+ - **Role-Based Coaching**: Tailored responses for coaches, players, and trainers
21
+ - **Video Recommendations**: AI-powered content suggestions using FAISS similarity search
22
+ - **Domain-Specific**: Focused exclusively on field hockey topics
23
+ - **Smart Filtering**: Automatic detection of hockey-related vs out-of-domain queries
24
+
25
+ ## Technology Stack
26
+
27
+ - **Frontend**: Gradio 4.8.0 for interactive web interface
28
+ - **AI Model**: OpenRouter API with GPT-4o for intelligent responses
29
+ - **Embeddings**: Sentence Transformers with multilingual support
30
+ - **Vector Search**: FAISS for fast similarity search
31
+ - **Database**: SQLite with pre-computed embeddings
32
+
33
+ ## Usage
34
+
35
+ Ask questions about:
36
+ - Field hockey training and drills
37
+ - Shooting techniques (backhand, forehand, drag flicks)
38
+ - Penalty corners and set pieces
39
+ - Player positioning and strategies
40
+ - Equipment and rules
41
+ - Youth coaching (U8, U10, etc.)
42
+
43
+ ## Environment Variables
44
+
45
+ Required for deployment:
46
+ - `OPENROUTER_API_KEY`: Your OpenRouter API key
47
+ - `DATABASE_PATH`: Path to the hockey video database (defaults to HockeyFood.db)