Spaces:
Sleeping
Sleeping
Claude commited on
Enable vector DB upload to GitHub and add upload guide
Browse filesChanges:
- Modified .gitignore to allow data/chroma_db/ upload
- Added UPLOAD_VECTOR_DB.md with step-by-step guide
- Includes both regular Git and Git LFS options
- PDF files still excluded from tracking
- .gitignore +1 -1
- UPLOAD_VECTOR_DB.md +163 -0
.gitignore
CHANGED
|
@@ -36,7 +36,7 @@ ENV/
|
|
| 36 |
*~
|
| 37 |
|
| 38 |
# Data
|
| 39 |
-
data/chroma_db/
|
| 40 |
data/*.pdf
|
| 41 |
*.pdf
|
| 42 |
|
|
|
|
| 36 |
*~
|
| 37 |
|
| 38 |
# Data
|
| 39 |
+
# data/chroma_db/ โ ๋ฒกํฐ DB๋ GitHub์ ์
๋ก๋
|
| 40 |
data/*.pdf
|
| 41 |
*.pdf
|
| 42 |
|
UPLOAD_VECTOR_DB.md
ADDED
|
@@ -0,0 +1,163 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# ๋ฒกํฐ DB GitHub ์
๋ก๋ ๊ฐ์ด๋
|
| 2 |
+
|
| 3 |
+
## ๐ฆ ํ์ฌ ์ํฉ
|
| 4 |
+
|
| 5 |
+
- โ
์ฝ๋: GitHub์ ์
๋ก๋ ์๋ฃ
|
| 6 |
+
- โ ๋ฒกํฐ DB: ์์ง ๋ก์ปฌ์์ ์์ฑ ์๋จ
|
| 7 |
+
|
| 8 |
+
## ๐ ์
๋ก๋ ๋จ๊ณ
|
| 9 |
+
|
| 10 |
+
### 1๏ธโฃ ๋ก์ปฌ์์ ์ธ๋ฑ์ฑ ์คํ
|
| 11 |
+
|
| 12 |
+
```bash
|
| 13 |
+
# 1. ๋ฆฌํฌ์งํ ๋ฆฌ ํด๋ก (๋ก์ปฌ ๋งฅ๋ถ)
|
| 14 |
+
git clone https://github.com/csjjin2025/Hallucination_and_Deception_for_financial_RAG.git
|
| 15 |
+
cd Hallucination_and_Deception_for_financial_RAG
|
| 16 |
+
|
| 17 |
+
# 2. ํ๊ฒฝ ์ค์
|
| 18 |
+
python -m venv venv
|
| 19 |
+
source venv/bin/activate
|
| 20 |
+
pip install -r requirements.txt
|
| 21 |
+
|
| 22 |
+
# 3. .env ํ์ผ ์์ฑ
|
| 23 |
+
cp .env.example .env
|
| 24 |
+
nano .env # API ํค์ PDF ๊ฒฝ๋ก ์
๋ ฅ
|
| 25 |
+
|
| 26 |
+
# 4. PDF ์ธ๋ฑ์ฑ (30-60๋ถ ์์)
|
| 27 |
+
python scripts/index_pdfs.py
|
| 28 |
+
```
|
| 29 |
+
|
| 30 |
+
### 2๏ธโฃ ์ธ๋ฑ์ฑ ์๋ฃ ํ์ธ
|
| 31 |
+
|
| 32 |
+
```bash
|
| 33 |
+
# ๋ฒกํฐ DB ํด๋ ํ์ธ
|
| 34 |
+
ls -la data/chroma_db/
|
| 35 |
+
|
| 36 |
+
# ๋ด์ฉ ํ์ธ
|
| 37 |
+
python scripts/check_vector_db.py
|
| 38 |
+
```
|
| 39 |
+
|
| 40 |
+
**์์ ๊ฒฐ๊ณผ:**
|
| 41 |
+
```
|
| 42 |
+
data/
|
| 43 |
+
โโโ chroma_db/
|
| 44 |
+
โโโ chroma.sqlite3
|
| 45 |
+
โโโ [UUID]/
|
| 46 |
+
โโโ ...
|
| 47 |
+
```
|
| 48 |
+
|
| 49 |
+
### 3๏ธโฃ GitHub์ ์
๋ก๋
|
| 50 |
+
|
| 51 |
+
#### ๋ฐฉ๋ฒ A: ์ผ๋ฐ Git (๋ฒกํฐ DB < 100MB)
|
| 52 |
+
|
| 53 |
+
```bash
|
| 54 |
+
# 1. ๋ณ๊ฒฝ์ฌํญ ํ์ธ
|
| 55 |
+
git status
|
| 56 |
+
|
| 57 |
+
# 2. ๋ฒกํฐ DB ์ถ๊ฐ
|
| 58 |
+
git add data/chroma_db/
|
| 59 |
+
|
| 60 |
+
# 3. ์ปค๋ฐ
|
| 61 |
+
git commit -m "Add indexed vector database (2,639 financial papers)"
|
| 62 |
+
|
| 63 |
+
# 4. ํธ์
|
| 64 |
+
git push origin main
|
| 65 |
+
```
|
| 66 |
+
|
| 67 |
+
#### ๋ฐฉ๋ฒ B: Git LFS (๋ฒกํฐ DB > 100MB) โญ ์ถ์ฒ
|
| 68 |
+
|
| 69 |
+
๋ฒกํฐ DB๊ฐ ํด ๊ฒฝ์ฐ Git LFS ์ฌ์ฉ:
|
| 70 |
+
|
| 71 |
+
```bash
|
| 72 |
+
# 1. Git LFS ์ค์น (๋งฅ)
|
| 73 |
+
brew install git-lfs
|
| 74 |
+
|
| 75 |
+
# 2. Git LFS ์ด๊ธฐํ
|
| 76 |
+
git lfs install
|
| 77 |
+
|
| 78 |
+
# 3. ChromaDB ํ์ผ ์ถ์
|
| 79 |
+
git lfs track "data/chroma_db/**/*"
|
| 80 |
+
git lfs track "*.sqlite3"
|
| 81 |
+
|
| 82 |
+
# 4. .gitattributes ํ์ผ ์ถ๊ฐ
|
| 83 |
+
git add .gitattributes
|
| 84 |
+
|
| 85 |
+
# 5. ๋ฒกํฐ DB ์ถ๊ฐ
|
| 86 |
+
git add data/chroma_db/
|
| 87 |
+
|
| 88 |
+
# 6. ์ปค๋ฐ ๋ฐ ํธ์
|
| 89 |
+
git commit -m "Add indexed vector database via Git LFS"
|
| 90 |
+
git push origin main
|
| 91 |
+
```
|
| 92 |
+
|
| 93 |
+
### 4๏ธโฃ ์
๋ก๋ ํ์ธ
|
| 94 |
+
|
| 95 |
+
GitHub ๋ฆฌํฌ์งํ ๋ฆฌ์์:
|
| 96 |
+
```
|
| 97 |
+
data/
|
| 98 |
+
โโโ chroma_db/ โ ์ด ํด๋๊ฐ ๋ณด์ฌ์ผ ํจ
|
| 99 |
+
```
|
| 100 |
+
|
| 101 |
+
## โ ๏ธ ์ฃผ์์ฌํญ
|
| 102 |
+
|
| 103 |
+
### 1. ์ฉ๋ ์ ํ
|
| 104 |
+
- **GitHub ์ผ๋ฐ ํ์ผ**: 100MB ์ ํ
|
| 105 |
+
- **Git LFS**: ๋ฌด๋ฃ ํ๋ 1GB/์
|
| 106 |
+
- **์์ ๋ฒกํฐ DB ํฌ๊ธฐ**: 500MB ~ 2GB
|
| 107 |
+
|
| 108 |
+
### 2. .gitignore ํ์ธ
|
| 109 |
+
ํ์ฌ `.gitignore`์์ `data/chroma_db/` ์ฃผ์ ์ฒ๋ฆฌ๋จ (์
๋ก๋ ๊ฐ๋ฅ)
|
| 110 |
+
|
| 111 |
+
### 3. PDF ์๋ณธ์ ์
๋ก๋ ์๋จ
|
| 112 |
+
`.gitignore`์์ `*.pdf` ์ ์ธ๋จ (์ ์)
|
| 113 |
+
|
| 114 |
+
## ๐ ๋ค๋ฅธ ์ฌ๋์ด ์ฌ์ฉํ๋ ๋ฐฉ๋ฒ
|
| 115 |
+
|
| 116 |
+
๋ฒกํฐ DB๊ฐ GitHub์ ์ฌ๋ผ๊ฐ ํ:
|
| 117 |
+
|
| 118 |
+
```bash
|
| 119 |
+
# 1. ํด๋ก
|
| 120 |
+
git clone https://github.com/csjjin2025/Hallucination_and_Deception_for_financial_RAG.git
|
| 121 |
+
cd Hallucination_and_Deception_for_financial_RAG
|
| 122 |
+
|
| 123 |
+
# 2. Git LFS pull (LFS ์ฌ์ฉ ์)
|
| 124 |
+
git lfs pull
|
| 125 |
+
|
| 126 |
+
# 3. ํ๊ฒฝ ์ค์
|
| 127 |
+
pip install -r requirements.txt
|
| 128 |
+
cp .env.example .env
|
| 129 |
+
nano .env # API ํค๋ง ์
๋ ฅ
|
| 130 |
+
|
| 131 |
+
# 4. ๋ฐ๋ก ์ฌ์ฉ ๊ฐ๋ฅ! (์ธ๋ฑ์ฑ ๋ถํ์)
|
| 132 |
+
uvicorn app.main:app --reload
|
| 133 |
+
```
|
| 134 |
+
|
| 135 |
+
## ๐ก ๋์: ํด๋ผ์ฐ๋ ์คํ ๋ฆฌ์ง
|
| 136 |
+
|
| 137 |
+
๋ฒกํฐ DB๊ฐ ๋๋ฌด ํฌ๋ฉด:
|
| 138 |
+
- **AWS S3**
|
| 139 |
+
- **Google Cloud Storage**
|
| 140 |
+
- **Dropbox/Google Drive**
|
| 141 |
+
|
| 142 |
+
README์ ๋ค์ด๋ก๋ ๋งํฌ ์ถ๊ฐ:
|
| 143 |
+
```markdown
|
| 144 |
+
## Vector Database Download
|
| 145 |
+
|
| 146 |
+
๋ฒกํฐ DB ๋ค์ด๋ก๋: [๋งํฌ](https://drive.google.com/...)
|
| 147 |
+
|
| 148 |
+
๋ค์ด๋ก๋ ํ `data/chroma_db/`์ ์์ถ ํด์
|
| 149 |
+
```
|
| 150 |
+
|
| 151 |
+
## ๐ ์ฉ๋ ํ์ธ
|
| 152 |
+
|
| 153 |
+
```bash
|
| 154 |
+
# ๋ฒกํฐ DB ์ฉ๋ ํ์ธ
|
| 155 |
+
du -sh data/chroma_db/
|
| 156 |
+
|
| 157 |
+
# ์์ ์ถ๋ ฅ
|
| 158 |
+
# 800M data/chroma_db/
|
| 159 |
+
```
|
| 160 |
+
|
| 161 |
+
---
|
| 162 |
+
|
| 163 |
+
**๋ค์ ๋จ๊ณ:** ๋ก์ปฌ ๋งฅ๋ถ์์ ์ธ๋ฑ์ฑ ์คํ ํ ์ด ๊ฐ์ด๋ ๋ฐ๋ผ ์
๋ก๋ํ์ธ์! ๐
|