README

.gitignore

@@ -8,4 +8,4 @@ __pycache__/
 .vscode/
 .DS_Store
 *.log
-
+.gradio

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 <Sohini Mallick>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,48 @@
+# HeritageScribe
+
+HeritageScribe is a lightweight web application for creating AI‑generated catalogue entries and conservation assessments of archaeological sites and artworks. Users upload an image, provide a few details, and the Gemma3n language model streams back structured Markdown text in real time. The app is built with [Gradio](https://www.gradio.app/) and runs the `unsloth/gemma-3n-E2B-it` model in 4‑bit mode for efficient inference.
+
+## Features
+
+- **Home** – introduction and instructions for new users.
+- **Generate** – upload an image and generate two types of reports:
+  - **Catalogue Entry** with sections for visual description, artistic details, cultural context, comparisons, and a JSON field log.
+  - **Conservation Assessment** with damage and recommendation notes.
+  Generation parameters (temperature, beam search, and max tokens) are adjustable.
+- **Dashboard** – displays all generated entries in one place for easy review.
+
+## Installation
+
+1. Clone this repository.
+2. Install Python 3.10 or later.
+3. Install the dependencies:
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+A CUDA‑capable GPU is recommended for running the model.
+
+## Usage
+
+Launch the Gradio interface with:
+
+```bash
+python app.py
+```
+
+Open the provided local URL in your browser. From the **Generate** tab you can fill in site details, upload a heritage image, and start generating. Results are streamed to the page and stored so you can view them later in the **Dashboard** tab.
+
+## Project Layout
+
+- `app.py` – entry point that creates the Gradio interface.
+- `helpers/` – UI components and utility classes.
+- `templates/` – text templates that build prompts for the Gemma model.
+- `requirements.txt` – Python package requirements.
+
+## License
+
+See the `LICENSE` file for licensing information.
+
+## Contributing
+
+Contributions and issues are welcome. Feel free to open a pull request or file an issue if you encounter problems or have suggestions.