Update README.md
Browse files
README.md
CHANGED
|
@@ -8,10 +8,12 @@ license: apache-2.0
|
|
| 8 |
|
| 9 |
<img src="https://github.com/lrncrd/PyPotteryInk/blob/main/imgs/pypotteryink.png?raw=true" width="250"/>
|
| 10 |
|
| 11 |
-
[](https://lrncrd.github.io/PyPotteryInk/)
|
| 13 |
[](https://huggingface.co/lrncrd/PyPotteryInk)
|
| 14 |
[](https://www.python.org/downloads/)
|
|
|
|
|
|
|
| 15 |
|
| 16 |
*Transform archaeological pottery drawings into publication-ready illustrations with AI*
|
| 17 |
|
|
@@ -50,6 +52,8 @@ As part of the **PyPottery** toolkit, `PyPotteryInk` is a deep learning applicat
|
|
| 50 |
|-------|-------------|------|------|
|
| 51 |
| **10k Model** | General-purpose model for pottery drawings | 38.3MB | [Download](https://huggingface.co/lrncrd/PyPotteryInk/resolve/main/model_10k.pkl?download=true) |
|
| 52 |
| **6h-MCG Model** | High-quality model for Bronze Age drawings | 38.3MB | [Download](https://huggingface.co/lrncrd/PyPotteryInk/resolve/main/6h-MCG.pkl?download=true) |
|
|
|
|
|
|
|
| 53 |
|
| 54 |
|
| 55 |
|
|
@@ -58,14 +62,13 @@ All models support custom fine-tuning for specific archaeological contexts or st
|
|
| 58 |
## ⚡ Benchmarks
|
| 59 |
|
| 60 |
|
| 61 |
-
| GPU |
|
| 62 |
| ------------------- | -------------------------------- |
|
| 63 |
-
| 3070Ti (Windows 11) |
|
| 64 |
-
|
|
| 65 |
-
|
| 66 |
-
|
| 67 |
|
| 68 |
-
The benchmarks were performed using the `test.py` script.
|
| 69 |
|
| 70 |
## 📢 AI Disclosure and Citation
|
| 71 |
|
|
@@ -95,16 +98,34 @@ If you use PyPotteryInk in your research, please cite:
|
|
| 95 |
title = {PyPotteryInk: Transform archaeological pottery drawings into publication-ready illustrations with AI},
|
| 96 |
year = {2025},
|
| 97 |
url = {https://github.com/lrncrd/PyPotteryInk},
|
| 98 |
-
version = {0.0.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 99 |
}
|
| 100 |
```
|
| 101 |
|
| 102 |
|
| 103 |
## 👥 Contributors
|
| 104 |
|
| 105 |
-
|
| 106 |
-
<a href="https://github.com/lrncrd">
|
| 107 |
-
<img src="https://
|
| 108 |
</a>
|
| 109 |
|
| 110 |
|
|
@@ -116,4 +137,5 @@ Based on img2img-turbo by [GaParmar](https://github.com/GaParmar/img2img-turbo)
|
|
| 116 |
|
| 117 |
The original code was released under the MIT Licence. The changes made in this fork are released under the Apache License 2.0.
|
| 118 |
|
|
|
|
| 119 |
---
|
|
|
|
| 8 |
|
| 9 |
<img src="https://github.com/lrncrd/PyPotteryInk/blob/main/imgs/pypotteryink.png?raw=true" width="250"/>
|
| 10 |
|
| 11 |
+
[](https://lrncrd.github.io/PyPotteryInk/)
|
| 12 |
[](https://lrncrd.github.io/PyPotteryInk/)
|
| 13 |
[](https://huggingface.co/lrncrd/PyPotteryInk)
|
| 14 |
[](https://www.python.org/downloads/)
|
| 15 |
+
[](https://doi.org/10.1016/j.culher.2025.06.016)
|
| 16 |
+
|
| 17 |
|
| 18 |
*Transform archaeological pottery drawings into publication-ready illustrations with AI*
|
| 19 |
|
|
|
|
| 52 |
|-------|-------------|------|------|
|
| 53 |
| **10k Model** | General-purpose model for pottery drawings | 38.3MB | [Download](https://huggingface.co/lrncrd/PyPotteryInk/resolve/main/model_10k.pkl?download=true) |
|
| 54 |
| **6h-MCG Model** | High-quality model for Bronze Age drawings | 38.3MB | [Download](https://huggingface.co/lrncrd/PyPotteryInk/resolve/main/6h-MCG.pkl?download=true) |
|
| 55 |
+
| **6h-MC Model** | High-quality model for Protohistoric and Historic drawings | 38.3MB | [Download](https://huggingface.co/lrncrd/PyPotteryInk/resolve/main/6h-MC.pkl?download=true) |
|
| 56 |
+
| **4h-PAINT Model** | Tailored model for Historic and painted pottery | 38.3MB | [Download](https://huggingface.co/lrncrd/PyPotteryInk/resolve/main/4h-PAINT.pkl?download=true) |
|
| 57 |
|
| 58 |
|
| 59 |
|
|
|
|
| 62 |
## ⚡ Benchmarks
|
| 63 |
|
| 64 |
|
| 65 |
+
| GPU | Processing time for `test_image.jpg` (s) |
|
| 66 |
| ------------------- | -------------------------------- |
|
| 67 |
+
| 3070Ti (Windows 11) | 51.48 |
|
| 68 |
+
| T4 (Google Colab) | 57.56 |
|
| 69 |
+
|
| 70 |
+
The benchmarks were performed using the `process_single_image` function.
|
| 71 |
|
|
|
|
| 72 |
|
| 73 |
## 📢 AI Disclosure and Citation
|
| 74 |
|
|
|
|
| 98 |
title = {PyPotteryInk: Transform archaeological pottery drawings into publication-ready illustrations with AI},
|
| 99 |
year = {2025},
|
| 100 |
url = {https://github.com/lrncrd/PyPotteryInk},
|
| 101 |
+
version = {0.0.3}
|
| 102 |
+
}
|
| 103 |
+
```
|
| 104 |
+
|
| 105 |
+
or
|
| 106 |
+
|
| 107 |
+
```bibtex
|
| 108 |
+
@article{cardarelli_pypotteryink_2025,
|
| 109 |
+
title = {{PyPotteryInk}: One-step diffusion model for sketch to publication-ready archaeological drawings},
|
| 110 |
+
volume = {74},
|
| 111 |
+
issn = {1296-2074},
|
| 112 |
+
url = {https://www.sciencedirect.com/science/article/pii/S1296207425001268},
|
| 113 |
+
doi = {10.1016/j.culher.2025.06.016},
|
| 114 |
+
shorttitle = {{PyPotteryInk}},
|
| 115 |
+
pages = {300--310},
|
| 116 |
+
journaltitle = {Journal of Cultural Heritage},
|
| 117 |
+
author = {Cardarelli, Lorenzo},
|
| 118 |
+
date = {2025-07-01},
|
| 119 |
+
keywords = {Archaeological drawing, Diffusion models, Generative {AI}, Image-to-image translation, Pottery},
|
| 120 |
}
|
| 121 |
```
|
| 122 |
|
| 123 |
|
| 124 |
## 👥 Contributors
|
| 125 |
|
| 126 |
+
|
| 127 |
+
<a href="https://github.com/lrncrd/PyPotteryInk/graphs/contributors">
|
| 128 |
+
<img src="https://contrib.rocks/image?repo=lrncrd/PyPotteryInk" />
|
| 129 |
</a>
|
| 130 |
|
| 131 |
|
|
|
|
| 137 |
|
| 138 |
The original code was released under the MIT Licence. The changes made in this fork are released under the Apache License 2.0.
|
| 139 |
|
| 140 |
+
|
| 141 |
---
|