Spaces:
Sleeping
Sleeping
Delete README.md
Browse files
README.md
DELETED
|
@@ -1,52 +0,0 @@
|
|
| 1 |
-
|
| 2 |
-
<p align="center">
|
| 3 |
-
<img src="assets/images/image_logo.png" alt="Hugging Research logo" width="120" />
|
| 4 |
-
</p>
|
| 5 |
-
<h1 align="center">Hugging Research</h1>
|
| 6 |
-
|
| 7 |
-
Hugging Research is a lightweight CodeAgent‑based research assistant for the Hugging Face Hub (models, datasets, Spaces, users, collections, papers). It gathers links via dedicated tools and organizes them for easy review.
|
| 8 |
-
|
| 9 |
-

|
| 10 |
-
|
| 11 |
-
## What it does
|
| 12 |
-
- Finds relevant models/datasets/Spaces/papers on the Hub
|
| 13 |
-
- Uses domain‑restricted search for tutorials and docs
|
| 14 |
-
- Avoids hallucinated links (only cites tool‑returned URLs)
|
| 15 |
-
- Organizes the found links into a simple, categorized view in the Report view
|
| 16 |
-
|
| 17 |
-
## Quick start
|
| 18 |
-
1) Clone and install
|
| 19 |
-
```bash
|
| 20 |
-
git clone https://github.com/mcdaqc/hugging-research
|
| 21 |
-
cd hugging-research
|
| 22 |
-
python -m venv venv
|
| 23 |
-
venv\Scripts\activate # Windows
|
| 24 |
-
pip install -r requirements.txt
|
| 25 |
-
```
|
| 26 |
-
|
| 27 |
-
2) Configure your environment
|
| 28 |
-
```bash
|
| 29 |
-
cp .env.template .env
|
| 30 |
-
# Edit .env and set:
|
| 31 |
-
# HF_TOKEN=hf_xxx # only for the inference model
|
| 32 |
-
# MODEL_ID=Qwen/Qwen3-Coder-480B-A35B-Instruct # optional
|
| 33 |
-
```
|
| 34 |
-
|
| 35 |
-
3) Run the app
|
| 36 |
-
```bash
|
| 37 |
-
python app.py
|
| 38 |
-
# open http://localhost:7860
|
| 39 |
-
```
|
| 40 |
-
|
| 41 |
-
4) Use the app
|
| 42 |
-
- Enter your Hugging Face API key in the sidebar
|
| 43 |
-
- Click a Basic/Medium/Advanced example, or type your query in natural language
|
| 44 |
-
- Review the organized links in the Report view
|
| 45 |
-
|
| 46 |
-
## Configuration
|
| 47 |
-
- `HF_TOKEN`: used for the inference model (agent). Tools are anonymous/read‑only.
|
| 48 |
-
- `MODEL_ID`: default `Qwen/Qwen3-Coder-480B-A35B-Instruct`.
|
| 49 |
-
|
| 50 |
-
|
| 51 |
-
|
| 52 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|