SyedWaqad commited on
Commit
9490c1d
·
verified ·
1 Parent(s): 487ccc0

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +26 -45
README.md CHANGED
@@ -9,49 +9,30 @@ app_file: app.py
9
  pinned: false
10
  license: mit
11
  ---
 
12
 
13
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
14
- Polymer Evaluation Tool
15
- =======================
16
-
17
- This is a Gradio-based web app for selecting polymers, viewing their details and chemical properties, and evaluating suitability for specific applications like water treatment. It uses Groq API for AI-driven assessments.
18
-
19
- Prerequisites
20
- -------------
21
- - Python 3.8+ installed.
22
- - A Groq API key (sign up at https://console.groq.com and generate one at https://console.groq.com/keys).
23
-
24
- Setup
25
- -----
26
- 1. Clone or download the files: requirements.txt, readme.txt, app.py, and optionally .env.
27
- 2. Install dependencies: Run `pip install -r requirements.txt`.
28
- 3. Create a `.env` file in the project root with your Groq API key:
29
- GROQ_API_KEY=your_groq_api_key_here
30
- (This keeps the key secure; do not hardcode it in app.py.)
31
- 4. Run the app: `python app.py`. Open the provided local URL (e.g., http://127.0.0.1:7860) in your browser.
32
-
33
- Usage
34
- -----
35
- - Select a polymer from the dropdown to view its details and chemical properties.
36
- - Select a treatment (e.g., "Water Treatment") and click "Evaluate" to get a detailed AI assessment via Groq.
37
- - The evaluation uses Groq's Llama-3 model to reason based on the polymer's properties.
38
-
39
- Deployment to Hugging Face Spaces
40
- ---------------------------------
41
- 1. Create a new Space on Hugging Face[](https://huggingface.co/spaces) with Python/Gradio template.
42
- 2. Upload app.py, requirements.txt, and .env (but set GROQ_API_KEY as a Secret in Space settings instead of uploading .env).
43
- 3. The Space will auto-build and host the app publicly.
44
-
45
- Customization
46
- -------------
47
- - Add more polymers: Edit the `details_dict` in app.py.
48
- - Expand treatments: Add options to the treatment dropdown.
49
- - For production, handle errors (e.g., invalid API key) and add more dynamic data fetching if needed.
50
-
51
- Limitations
52
- -----------
53
- - Polymer details are hardcoded for simplicity; expand with a database or API for more.
54
- - Groq API requires an active key and may incur costs for heavy usage.
55
- - App is basic; enhance with images or advanced UI as needed.
56
-
57
- For issues, refer to Gradio docs[](https://gradio.app) or Groq docs[](https://console.groq.com/docs).
 
9
  pinned: false
10
  license: mit
11
  ---
12
+ # Polymer Evaluation Tool 🧪
13
 
14
+ An interactive **Gradio-based web app** that helps analyze and evaluate polymers for specific applications such as **water treatment**.
15
+ The app uses **Groq's Llama-3 model** for AI-driven reasoning and suitability assessments.
16
+
17
+ ---
18
+
19
+ ## 🚀 Features
20
+ - Select polymers and view their chemical properties.
21
+ - Evaluate suitability for specific treatment types (e.g., water treatment).
22
+ - AI-powered reasoning using Groq’s Llama-3 model.
23
+ - Secure API key management with `.env` or Hugging Face Secrets.
24
+
25
+ ---
26
+
27
+ ## 🧰 Requirements
28
+ - Python 3.8 or later
29
+ - A valid [Groq API key](https://console.groq.com/keys)
30
+
31
+ ---
32
+
33
+ ## ⚙️ Setup (Local Use)
34
+
35
+ 1. Clone or download the repository:
36
+ ```bash
37
+ git clone <your_repo_url>
38
+ cd <your_repo_folder>