Docint documentation update - #245
Conversation
There was a problem hiding this comment.
Pull Request Overview
Updates the document-intelligence project documentation with comprehensive technology stack details and improved setup instructions.
- Documents currently used frameworks, technologies, and their experiences (good/bad)
- Replaces Docker commands with docker-compose setup
- Updates environment variable configuration with proper .env.example file
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| document-intelligence/README.md | Added detailed technology stack documentation and updated setup instructions |
| document-intelligence/.env.example | Created proper environment variable template file |
| document-intelligence/exampleEnv | Removed old environment file format |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| - **Backend:** FastAPI (Python) | ||
| - **Dependency management:** Poetry | ||
| - **Containerization:** Docker (for containerized development with hot-reload) | ||
| - **LLM for text extraction:** Gemma 27 B (used; Gemma 4 B & 12 B were not good) |
There was a problem hiding this comment.
The model size should be written as '27B' instead of '27 B' to follow standard naming conventions for language models.
| - **OpenAPI code generator:** Worked well for generating client code. | ||
|
|
||
| ### Bad / Limitations | ||
| - **Gemma 4 B & 12 B:** Poor performance for text extraction. |
There was a problem hiding this comment.
The model sizes should be written as '4B & 12B' instead of '4 B & 12 B' to follow standard naming conventions for language models.
| # Uncomment next line to enable the debug mode | ||
| # ORPHEUS_DEBUG=1 |
There was a problem hiding this comment.
The environment variable name 'ORPHEUS_DEBUG' is inconsistent with 'ORPHEUS_VERBOSE' mentioned in the removed exampleEnv file. Consider using consistent naming across the project.
| # Uncomment next line to enable the debug mode | |
| # ORPHEUS_DEBUG=1 | |
| # Uncomment next line to enable the debug/verbose mode | |
| # ORPHEUS_VERBOSE=1 |
No description provided.