GuidK commited on
Commit
6562a72
·
verified ·
1 Parent(s): 64b78aa

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +33 -6
README.md CHANGED
@@ -1,14 +1,41 @@
1
  ---
2
  title: NLP Toolkit
3
- emoji: 🔥
4
- colorFrom: purple
5
- colorTo: gray
6
  sdk: gradio
7
- sdk_version: 6.14.0
8
- python_version: '3.13'
9
  app_file: app.py
10
  pinned: false
11
  license: mit
 
 
 
 
 
 
12
  ---
13
 
14
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  title: NLP Toolkit
3
+ emoji: 🛠️
4
+ colorFrom: blue
5
+ colorTo: indigo
6
  sdk: gradio
7
+ sdk_version: 4.0.0
 
8
  app_file: app.py
9
  pinned: false
10
  license: mit
11
+ tags:
12
+ - nlp
13
+ - sentiment-analysis
14
+ - text-summarization
15
+ - translation
16
+ - gradio
17
  ---
18
 
19
+ # 🛠️ NLP Toolkit: Text Analysis Tools
20
+ A comprehensive AI-powered tool for text processing, featuring sentiment analysis, abstractive summarization, and English-to-Ukrainian translation in a single, unified interface.
21
+
22
+ ## 🎯 Target Audience
23
+ This tool is designed for students, researchers, journalists, and anyone working with large volumes of English text who needs to quickly extract emotional tone, generate concise summaries, or translate content into Ukrainian.
24
+
25
+ ## 🚀 How to Use
26
+ 1. **Select a Tool**: Navigate between the "Sentiment Analysis", "Summarization", and "Translation" tabs at the top.
27
+ 2. **Input Text**: Type or paste your English text into the input box. You can also click on any of the **Examples** at the bottom to see the tool in action instantly.
28
+ 3. **Run**: Click the primary action button (e.g., "Analyze Sentiment") or press Enter to get the results.
29
+
30
+ ## 🧠 Models Used
31
+ | Task | Model Name | Language |
32
+ |---|---|---|
33
+ | **Sentiment Analysis** | `distilbert-base-uncased-finetuned-sst-2-english` | English (EN) |
34
+ | **Summarization** | `facebook/bart-large-cnn` | English (EN) |
35
+ | **Translation** | `Helsinki-NLP/opus-mt-en-uk` | EN ➡️ UK |
36
+
37
+ ## ⚠️ Limitations & Disclaimers
38
+ * **Language Support**: The Sentiment Analysis and Summarization models are trained exclusively on English data. Inputting other languages will result in inaccurate outputs.
39
+ * **Text Length**: For the Summarization module, text is automatically truncated to the first 500 words to ensure stability and prevent memory overflows. A warning will appear if truncation occurs.
40
+ * **Translation Accuracy**: While the translation model is robust, it may struggle with highly specific technical jargon, slang, or complex idiomatic expressions.
41
+ * **HTML Safety**: All inputs are sanitized; however, the tool is intended for standard prose text.