tiny-press / docs /folder-structure.md
sriharsha-cr's picture
Project files
ebc3bf5

A newer version of the Gradio SDK is available: 6.18.0

Upgrade

Folder Structure

app/
β”œβ”€β”€ app.py                        # Entry point
β”œβ”€β”€ config.py                      # All tunable settings
β”œβ”€β”€ requirements.txt               # Pinned Python dependencies
β”œβ”€β”€ tinypress.db                   # SQLite DB (auto-created on first run)
β”‚
β”œβ”€β”€ ui/
β”‚   β”œβ”€β”€ compress_tab.py            # Compression UI tab
β”‚   └── history_tab.py             # Metrics history tab
β”‚
β”œβ”€β”€ core/
β”‚   β”œβ”€β”€ compressor.py              # Compression pipeline logic
β”‚   β”œβ”€β”€ scorer.py                  # Semantic similarity scoring
β”‚   β”œβ”€β”€ tokenizer_utils.py         # Token counting helpers
β”‚   └── diff.py                    # Word-level diff + HTML renderer for history view
β”‚
β”œβ”€β”€ models/
β”‚   └── model_loader.py            # Lazy model + embedder loading
β”‚
β”œβ”€β”€ db/
β”‚   β”œβ”€β”€ schema.sql                 # SQLite table definitions
β”‚   └── store.py                   # DB read/write operations
β”‚
β”œβ”€β”€ docs/                          # Project documentation
β”‚   β”œβ”€β”€ architecture.md
β”‚   β”œβ”€β”€ folder-structure.md
β”‚   β”œβ”€β”€ setup.md
β”‚   β”œβ”€β”€ get-started.md
β”‚   └── enhancements.md
β”‚
β”œβ”€β”€ my-notes/                      # Planning notes (not part of the app)
β”‚   └── overall-idea.md
β”‚
└── claude-grounding/              # Context files for Claude (not part of the app)
    β”œβ”€β”€ hackathon.md
    β”œβ”€β”€ tech-stack.md
    └── about-me.md

🏠 README.md