pkheria commited on
Commit
8e21552
·
verified ·
1 Parent(s): 4c24965

updated everything

Browse files
Files changed (1) hide show
  1. README.md +16 -37
README.md CHANGED
@@ -8,6 +8,17 @@ app_file: app.py
8
  pinned: true
9
  license: mit
10
  short_description: AI knowledge hub for groups, powered by Nvidia
 
 
 
 
 
 
 
 
 
 
 
11
  ---
12
 
13
  # BuildSmall KnowledgeHub
@@ -20,6 +31,11 @@ BuildSmall KnowledgeHub is a modular Gradio app for loading knowledge from:
20
 
21
  It extracts text, captures Medium image references/captions when available, chunks the content, embeds chunks locally with the configured NVIDIA Nemotron embedding model, uploads vectors into Qdrant, and generates grounded answers with NVIDIA's OpenAI-compatible chat API.
22
 
 
 
 
 
 
23
  ## NVIDIA Usage
24
 
25
  This project explicitly uses NVIDIA in two places:
@@ -37,20 +53,6 @@ You must provide `NVIDIA_API_KEY` as a Hugging Face Space secret or in your loca
37
 
38
  ## Hugging Face Spaces Deployment
39
 
40
- Create a new Hugging Face Space with:
41
-
42
- - SDK: `Gradio`
43
- - App file: `app.py`
44
- - Hardware: `ZeroGPU` if available, otherwise CPU/GPU according to your quota
45
- - Python dependencies: installed from `requirements.txt`
46
-
47
- Push this repository to the Space repo:
48
-
49
- ```bash
50
- git remote add space https://huggingface.co/spaces/<your-username>/<your-space-name>
51
- git push space main
52
- ```
53
-
54
  For ZeroGPU Spaces, add these Space variables:
55
 
56
  ```bash
@@ -92,16 +94,6 @@ HF_TOKEN=<token-if-needed-for-gated-model-downloads>
92
 
93
  Use a hosted Qdrant instance for Hugging Face Spaces. `localhost:6333` only works for local development.
94
 
95
- ## Medium Article Extraction
96
-
97
- Medium articles are fetched through Freedium:
98
-
99
- ```text
100
- https://freedium-mirror.cfd/
101
- ```
102
-
103
- Pass a Medium article URL into the app. The extractor builds a Freedium mirror URL, extracts the readable article text, collects image URLs and alt/caption text when available, then sends that combined content through the same chunking, embedding, and Qdrant upload pipeline.
104
-
105
  ## Qdrant Collection Name
106
 
107
  The Ingest and Retrieve tabs each have their own collection-name field. Set both to the same Qdrant collection when you want to search what you just ingested. The fields are intentionally not auto-synced because auto-sync can cause continuous refreshes in hosted Gradio Spaces.
@@ -132,16 +124,3 @@ python app.py
132
  Open the local Gradio URL printed in the terminal, usually `http://127.0.0.1:7860`.
133
 
134
  The app binds to `0.0.0.0:7860`, which is suitable for Hugging Face Spaces and container deployments.
135
-
136
- ## Project Structure
137
-
138
- ```text
139
- app/
140
- core/ settings and shared models
141
- extractors/ PDF, arXiv, and Medium extraction
142
- services/ chunking, embeddings, Qdrant, retrieval, ingestion orchestration
143
- ui/ Gradio Blocks UI
144
- utils/ source detection helpers
145
- ```
146
-
147
- Medium extraction uses `freedium-mirror.cfd`. arXiv ingestion downloads the paper PDF and parses it with `pypdf`.
 
8
  pinned: true
9
  license: mit
10
  short_description: AI knowledge hub for groups, powered by Nvidia
11
+ tags:
12
+ - hackathon:build-small
13
+ - track:backyard-ai
14
+ - badge:sharing-is-caring
15
+ - badge:field-notes
16
+ - badge:Best Use of Codex
17
+ - badge:Off Grid
18
+ - badge:Best Demo
19
+ - badge:Bonus Quest Champion
20
+ - sponsor:nvidia nemotron
21
+
22
  ---
23
 
24
  # BuildSmall KnowledgeHub
 
31
 
32
  It extracts text, captures Medium image references/captions when available, chunks the content, embeds chunks locally with the configured NVIDIA Nemotron embedding model, uploads vectors into Qdrant, and generates grounded answers with NVIDIA's OpenAI-compatible chat API.
33
 
34
+ ## 🔗 Resources & Links
35
+
36
+ - **Demo Video:** [Watch the Product Demo]([YOUR_DEMO_VIDEO_LINK_HERE](https://youtu.be/aDlKNW10pnw))
37
+ - **Blog Post:** [Read the Full Write-up][(YOUR_BLOG_POST_LINK_HERE](https://huggingface.co/blog/pkheria/knowledgemesh))
38
+ -
39
  ## NVIDIA Usage
40
 
41
  This project explicitly uses NVIDIA in two places:
 
53
 
54
  ## Hugging Face Spaces Deployment
55
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
56
  For ZeroGPU Spaces, add these Space variables:
57
 
58
  ```bash
 
94
 
95
  Use a hosted Qdrant instance for Hugging Face Spaces. `localhost:6333` only works for local development.
96
 
 
 
 
 
 
 
 
 
 
 
97
  ## Qdrant Collection Name
98
 
99
  The Ingest and Retrieve tabs each have their own collection-name field. Set both to the same Qdrant collection when you want to search what you just ingested. The fields are intentionally not auto-synced because auto-sync can cause continuous refreshes in hosted Gradio Spaces.
 
124
  Open the local Gradio URL printed in the terminal, usually `http://127.0.0.1:7860`.
125
 
126
  The app binds to `0.0.0.0:7860`, which is suitable for Hugging Face Spaces and container deployments.