Denys Kanunnikov commited on
Commit
b5514e1
Β·
1 Parent(s): 2f1dc83

fix README

Browse files
Files changed (1) hide show
  1. README.md +1 -44
README.md CHANGED
@@ -47,39 +47,20 @@ cd mcp-sentiment
47
 
48
  ### 2. Install Dependencies
49
  ```bash
50
- <<<<<<< HEAD
51
  python3 -m pip install -r requirements.txt
52
- =======
53
- pip install -r requirements.txt
54
- >>>>>>> 6c0a877e212b959072c8948b934d212c97a3c597
55
  ```
56
 
57
  ### 3. Download TextBlob Corpora (Optional)
58
  ```bash
59
- <<<<<<< HEAD
60
  python3 -c "import nltk; nltk.download('punkt'); nltk.download('brown')"
61
- =======
62
- python -c "import nltk; nltk.download('punkt'); nltk.download('brown')"
63
- >>>>>>> 6c0a877e212b959072c8948b934d212c97a3c597
64
  ```
65
 
66
  ## 🎯 Quick Start
67
 
68
  ### Run Tests
69
  ```bash
70
- <<<<<<< HEAD
71
  python3 app.py --mode test
72
- =======
73
- python app.py --mode test
74
- >>>>>>> 6c0a877e212b959072c8948b934d212c97a3c597
75
- ```
76
-
77
- ### Launch Web Interface
78
- ```bash
79
- <<<<<<< HEAD
80
- python3 app.py --mode gradio
81
  ```
82
- Visit `http://localhost:7860` to access the web interface.
83
 
84
  ### Launch Web Interface with MCP Server
85
  ```bash
@@ -103,11 +84,7 @@ python app.py --mode mcp
103
 
104
  ### Combined Mode (Default)
105
  ```bash
106
- <<<<<<< HEAD
107
  python3 app.py --mode combined
108
- =======
109
- python app.py --mode combined
110
- >>>>>>> 6c0a877e212b959072c8948b934d212c97a3c597
111
  ```
112
  Runs both MCP server and Gradio interface simultaneously.
113
 
@@ -117,7 +94,7 @@ Runs both MCP server and Gradio interface simultaneously.
117
 
118
  ```bash
119
  # Different execution modes
120
- <<<<<<< HEAD
121
  python3 app.py --mode mcp # MCP server only
122
  python3 app.py --mode gradio # Web interface only
123
  python3 app.py --mode combined # Both services (default)
@@ -131,20 +108,6 @@ python3 app.py --mode gradio --mcp-server # Enable MCP server in Gradio
131
 
132
  # Logging control
133
  python3 app.py --log-level DEBUG # Detailed logging
134
- =======
135
- python app.py --mode mcp # MCP server only
136
- python app.py --mode gradio # Web interface only
137
- python app.py --mode combined # Both services (default)
138
- python app.py --mode test # Run functionality tests
139
-
140
- # Gradio customization
141
- python app.py --mode gradio --port 8080 # Custom port
142
- python app.py --mode gradio --share # Enable public sharing
143
- python app.py --mode gradio --debug # Debug mode
144
-
145
- # Logging control
146
- python app.py --log-level DEBUG # Detailed logging
147
- >>>>>>> 6c0a877e212b959072c8948b934d212c97a3c597
148
  ```
149
 
150
  ### Python API Usage
@@ -206,7 +169,6 @@ The server provides these MCP tools:
206
  }
207
  ```
208
 
209
- <<<<<<< HEAD
210
  ## πŸ”— Gradio MCP Server Integration
211
 
212
  The Gradio web interface can also serve as an MCP server, providing API endpoints that correspond to each sentiment analysis function. This allows the same interface to serve both human users through the web UI and AI models through the MCP protocol.
@@ -259,8 +221,6 @@ curl -X POST http://localhost:7860/api/health_check \
259
  -d '{}'
260
  ```
261
 
262
- =======
263
- >>>>>>> 6c0a877e212b959072c8948b934d212c97a3c597
264
  ## πŸ—οΈ Architecture
265
 
266
  ### Project Structure
@@ -298,10 +258,7 @@ mcp-sentiment/
298
  # Optional configuration
299
  export MCP_LOG_LEVEL=INFO
300
  export GRADIO_SERVER_PORT=7860
301
- <<<<<<< HEAD
302
  export GRADIO_MCP_SERVER=true # Enable MCP server in Gradio interface
303
- =======
304
- >>>>>>> 6c0a877e212b959072c8948b934d212c97a3c597
305
  export TRANSFORMERS_CACHE=/path/to/cache
306
  ```
307
 
 
47
 
48
  ### 2. Install Dependencies
49
  ```bash
 
50
  python3 -m pip install -r requirements.txt
 
 
 
51
  ```
52
 
53
  ### 3. Download TextBlob Corpora (Optional)
54
  ```bash
 
55
  python3 -c "import nltk; nltk.download('punkt'); nltk.download('brown')"
 
 
 
56
  ```
57
 
58
  ## 🎯 Quick Start
59
 
60
  ### Run Tests
61
  ```bash
 
62
  python3 app.py --mode test
 
 
 
 
 
 
 
 
 
63
  ```
 
64
 
65
  ### Launch Web Interface with MCP Server
66
  ```bash
 
84
 
85
  ### Combined Mode (Default)
86
  ```bash
 
87
  python3 app.py --mode combined
 
 
 
88
  ```
89
  Runs both MCP server and Gradio interface simultaneously.
90
 
 
94
 
95
  ```bash
96
  # Different execution modes
97
+
98
  python3 app.py --mode mcp # MCP server only
99
  python3 app.py --mode gradio # Web interface only
100
  python3 app.py --mode combined # Both services (default)
 
108
 
109
  # Logging control
110
  python3 app.py --log-level DEBUG # Detailed logging
 
 
 
 
 
 
 
 
 
 
 
 
 
 
111
  ```
112
 
113
  ### Python API Usage
 
169
  }
170
  ```
171
 
 
172
  ## πŸ”— Gradio MCP Server Integration
173
 
174
  The Gradio web interface can also serve as an MCP server, providing API endpoints that correspond to each sentiment analysis function. This allows the same interface to serve both human users through the web UI and AI models through the MCP protocol.
 
221
  -d '{}'
222
  ```
223
 
 
 
224
  ## πŸ—οΈ Architecture
225
 
226
  ### Project Structure
 
258
  # Optional configuration
259
  export MCP_LOG_LEVEL=INFO
260
  export GRADIO_SERVER_PORT=7860
 
261
  export GRADIO_MCP_SERVER=true # Enable MCP server in Gradio interface
 
 
262
  export TRANSFORMERS_CACHE=/path/to/cache
263
  ```
264