rdune71 commited on
Commit
6948d18
Β·
verified Β·
1 Parent(s): c3a4b57

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +62 -9
README.md CHANGED
@@ -1,16 +1,69 @@
1
  ---
2
- title: Myspace14
3
- emoji: πŸ’¬
4
- colorFrom: yellow
5
  colorTo: purple
6
  sdk: gradio
7
- sdk_version: 5.42.0
8
  app_file: app.py
9
  pinned: false
10
- hf_oauth: true
11
- hf_oauth_scopes:
12
- - inference-api
13
- license: apache-2.0
14
  ---
15
 
16
- 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: GPT-OSS Research Assistant
3
+ emoji: πŸŽ“
4
+ colorFrom: blue
5
  colorTo: purple
6
  sdk: gradio
7
+ sdk_version: 4.29.0
8
  app_file: app.py
9
  pinned: false
10
+ license: openrail
 
 
 
11
  ---
12
 
13
+ # πŸŽ“ GPT-OSS Research Assistant
14
+
15
+ An advanced AI assistant with academic research capabilities powered by GPT-OSS 20B model.
16
+
17
+ ## Features
18
+
19
+ ### πŸ€– Core AI Capabilities
20
+ - **GPT-OSS 20B Model**: Powerful language understanding and generation
21
+ - **Streaming Responses**: Real-time response generation
22
+ - **Conversation Memory**: Context-aware dialogue management
23
+
24
+ ### πŸ” Research & Academic Tools
25
+ - **Web Search**: Integrated Tavily search engine
26
+ - **Academic Paper Analysis**: arXiv and Semantic Scholar integration
27
+ - **PDF Processing**: Direct analysis of research documents
28
+ - **Literature Reviews**: Automated literature review generation
29
+ - **Citation Management**: Bibliography and citation generation
30
+ - **URL Analysis**: Process any webpage or document URL
31
+
32
+ ### πŸ› οΈ Advanced Features
33
+ - **Research Mode**: Specialized handling for academic queries
34
+ - **Export Functionality**: Save conversations in JSON/Text formats
35
+ - **Follow-up Questions**: AI-suggested next questions
36
+ - **Dark/Light Theme**: Customizable interface
37
+ - **Rate Limiting**: Prevent API abuse
38
+ - **Usage Analytics**: Track performance metrics
39
+
40
+ ### πŸ“Š User Experience
41
+ - **Tabbed Interface**: Organized chat and research tools
42
+ - **Feedback System**: Rate response quality
43
+ - **Export Options**: Save your research
44
+ - **Responsive Design**: Works on all devices
45
+
46
+ ## Getting Started
47
+
48
+ 1. Set your `HF_TOKEN` environment variable
49
+ 2. Install dependencies: `pip install -r requirements.txt`
50
+ 3. Run the app: `python app.py`
51
+
52
+ ## Usage Tips
53
+
54
+ - Enable **Research Mode** for academic queries
55
+ - Use the **Research Tools** tab for advanced analysis
56
+ - Process PDF URLs directly for document analysis
57
+ - Generate literature reviews for research topics
58
+ - Export your conversations for later reference
59
+
60
+ ## API Requirements
61
+
62
+ - **Hugging Face Token**: For model access
63
+ - **Tavily API Key**: For web search (optional but recommended)
64
+
65
+ ## Model Information
66
+
67
+ **Primary Model**: `DavidAU/OpenAi-GPT-oss-20b-abliterated-uncensored-NEO-Imatrix-gguf`
68
+
69
+ This model provides powerful language understanding capabilities for research and general conversation.