Skip to content

Commit

Permalink
Add repo structure
Browse files Browse the repository at this point in the history
  • Loading branch information
JustinHsu1019 committed Nov 13, 2024
1 parent f11c27c commit ab7b01a
Showing 1 changed file with 40 additions and 1 deletion.
41 changes: 40 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,46 @@

## Repo Structure
```
(主要用 # 介紹沒有在 folder 內獨立檔案)
.
├── .github
│ ├── contribute_guide.md
│ └── workflows
│ └── ci.yml
├── .gitignore # 讓 git 忽略的檔案和目錄 (e.g. cache, logs, etc.)
├── .pre-commit-config.yaml # 設定 pre-commit hooks 以檢查與格式化代碼、環境配置、Git 設定及檢測敏感資訊
├── .ruff.toml # ruff 設定檔,lint: pep8-naming, pycodestyle, pyflakes, etc.
├── LICENSE # MIT License
├── Model
│ ├── README.md
│ ├── flask_app.py
│ └── utils
│ ├── README.md
│ ├── __init__.py
│ ├── config_log.py
│ └── retrieval_agent.py
├── Preprocess
│ ├── README.md
│ ├── data_process
│ │ ├── README.md
│ │ ├── conbine_readpdf_result.py
│ │ ├── merge_with_ocr_pdfminer.py
│ │ ├── read_pdf_noocr.py
│ │ └── read_pdf_ocr.py
│ └── insert_data.py
├── README.md
├── config_example.ini # 設定檔範例,需自己複製一份成 config.ini 並修改
├── data
│ └── README.md
├── docker
│ ├── README.md
│ ├── docker-compose.yml
│ └── docker_install.sh
├── main.py # 主程式
├── requirements.txt # Python pip 環境需求
└── testing
├── README.md
├── checkans.py
└── get_best_alpha.py
```

## Setup Environment
Expand Down

0 comments on commit ab7b01a

Please sign in to comment.