Update README.md
Browse files
README.md
CHANGED
|
@@ -4,7 +4,7 @@ emoji: 🏢
|
|
| 4 |
colorFrom: blue
|
| 5 |
colorTo: purple
|
| 6 |
sdk: gradio
|
| 7 |
-
sdk_version: "4.
|
| 8 |
app_file: app.py
|
| 9 |
pinned: false
|
| 10 |
---
|
|
@@ -30,12 +30,15 @@ A Hugging Face Gradio application that generates CLIP-ready visual descriptions
|
|
| 30 |
2. Click "Create new Space"
|
| 31 |
3. Choose "Gradio" as the SDK
|
| 32 |
4. Upload `app.py`, `requirements.txt`, and `README.md`
|
| 33 |
-
5. **
|
| 34 |
-
- Go to your Space's Settings
|
| 35 |
-
-
|
| 36 |
-
-
|
| 37 |
-
-
|
| 38 |
-
|
|
|
|
|
|
|
|
|
|
| 39 |
|
| 40 |
### 2. Prepare Your CSV Files
|
| 41 |
|
|
@@ -51,16 +54,17 @@ Equipment,additional_data
|
|
| 51 |
|
| 52 |
### 3. Use the Application
|
| 53 |
|
| 54 |
-
1. **
|
| 55 |
-
2. **
|
| 56 |
-
3. **
|
|
|
|
| 57 |
- Max Tokens: 64-512 (default: 256)
|
| 58 |
- Temperature: 0.1-1.0 (default: 0.7)
|
| 59 |
- Top-p: 0.1-1.0 (default: 0.9)
|
| 60 |
-
|
| 61 |
-
|
| 62 |
|
| 63 |
-
*Note: Authentication
|
| 64 |
|
| 65 |
## Output Format
|
| 66 |
|
|
@@ -88,25 +92,27 @@ Car Rental For Self Driven,"a car available for self-drive rental, parked at a p
|
|
| 88 |
## Technical Details
|
| 89 |
|
| 90 |
- **Model**: meta-llama/Llama-3.3-70B-Instruct
|
| 91 |
-
- **Framework**: Gradio 4.
|
| 92 |
- **Processing**: Categories are deduplicated automatically
|
| 93 |
- **Output Files**: Named as `output_{original_name}_{timestamp}.csv`
|
| 94 |
|
| 95 |
## Troubleshooting
|
| 96 |
|
| 97 |
-
### "
|
| 98 |
-
- Make sure
|
| 99 |
-
- Go to Space Settings →
|
| 100 |
-
-
|
|
|
|
| 101 |
|
| 102 |
### "Column not found" error
|
| 103 |
- Check that the column name matches exactly (case-sensitive)
|
| 104 |
- View the error message to see available columns
|
| 105 |
|
| 106 |
### Authentication errors
|
| 107 |
-
- Ensure
|
| 108 |
-
-
|
| 109 |
- Verify that your account has access to the Llama 3.3 model
|
|
|
|
| 110 |
|
| 111 |
### Slow processing
|
| 112 |
- The model processes each unique category individually
|
|
@@ -136,4 +142,5 @@ Get your token from: https://huggingface.co/settings/tokens
|
|
| 136 |
|
| 137 |
## License
|
| 138 |
|
| 139 |
-
This project uses the Llama 3.3 model which requires agreement to Meta's license terms.
|
|
|
|
|
|
| 4 |
colorFrom: blue
|
| 5 |
colorTo: purple
|
| 6 |
sdk: gradio
|
| 7 |
+
sdk_version: "4.44.0"
|
| 8 |
app_file: app.py
|
| 9 |
pinned: false
|
| 10 |
---
|
|
|
|
| 30 |
2. Click "Create new Space"
|
| 31 |
3. Choose "Gradio" as the SDK
|
| 32 |
4. Upload `app.py`, `requirements.txt`, and `README.md`
|
| 33 |
+
5. **Add Your HF Token as a Secret (Required)**:
|
| 34 |
+
- Go to your Space's Settings (gear icon)
|
| 35 |
+
- Find the "Repository secrets" or "Secrets" section
|
| 36 |
+
- Click "Add a secret" or "New secret"
|
| 37 |
+
- Enter:
|
| 38 |
+
- **Name**: `HF_TOKEN`
|
| 39 |
+
- **Value**: Your Hugging Face token (get from https://huggingface.co/settings/tokens)
|
| 40 |
+
- Click "Save"
|
| 41 |
+
6. Your app will be deployed and restart automatically!
|
| 42 |
|
| 43 |
### 2. Prepare Your CSV Files
|
| 44 |
|
|
|
|
| 54 |
|
| 55 |
### 3. Use the Application
|
| 56 |
|
| 57 |
+
1. **Login** (optional): Click the "Login" button in the sidebar to authenticate with your HF account
|
| 58 |
+
2. **Upload Files**: Upload one or more CSV files
|
| 59 |
+
3. **Specify Column**: Enter the name of the column containing categories (default: "category")
|
| 60 |
+
4. **Adjust Settings** (optional):
|
| 61 |
- Max Tokens: 64-512 (default: 256)
|
| 62 |
- Temperature: 0.1-1.0 (default: 0.7)
|
| 63 |
- Top-p: 0.1-1.0 (default: 0.9)
|
| 64 |
+
5. **Process**: Click "Process Files" and wait for completion
|
| 65 |
+
6. **Download**: Download the output CSV files with descriptions
|
| 66 |
|
| 67 |
+
*Note: Authentication works via the HF_TOKEN secret you added in Space settings.*
|
| 68 |
|
| 69 |
## Output Format
|
| 70 |
|
|
|
|
| 92 |
## Technical Details
|
| 93 |
|
| 94 |
- **Model**: meta-llama/Llama-3.3-70B-Instruct
|
| 95 |
+
- **Framework**: Gradio 4.44+
|
| 96 |
- **Processing**: Categories are deduplicated automatically
|
| 97 |
- **Output Files**: Named as `output_{original_name}_{timestamp}.csv`
|
| 98 |
|
| 99 |
## Troubleshooting
|
| 100 |
|
| 101 |
+
### "Please login with your Hugging Face account" error
|
| 102 |
+
- Make sure you've added `HF_TOKEN` as a Secret in your Space settings
|
| 103 |
+
- Go to Space Settings → Secrets → Add a secret
|
| 104 |
+
- Name: `HF_TOKEN`, Value: your token from https://huggingface.co/settings/tokens
|
| 105 |
+
- Restart your Space after adding the secret
|
| 106 |
|
| 107 |
### "Column not found" error
|
| 108 |
- Check that the column name matches exactly (case-sensitive)
|
| 109 |
- View the error message to see available columns
|
| 110 |
|
| 111 |
### Authentication errors
|
| 112 |
+
- Ensure your HF token has proper permissions (Read access minimum)
|
| 113 |
+
- For Pro features, make sure you have a Hugging Face Pro account
|
| 114 |
- Verify that your account has access to the Llama 3.3 model
|
| 115 |
+
- Check that the token hasn't expired
|
| 116 |
|
| 117 |
### Slow processing
|
| 118 |
- The model processes each unique category individually
|
|
|
|
| 142 |
|
| 143 |
## License
|
| 144 |
|
| 145 |
+
This project uses the Llama 3.3 model which requires agreement to Meta's license terms.
|
| 146 |
+
|