Update README to render correctly on PyPi

README.md

@@ -21,7 +21,7 @@ tags:
 NisabaRelief
 </h1>
 
-<img src="./assets/NisabaRelief-Logo.png" width="600"/>
+<img src="https://huggingface.co/boatbomber/NisabaRelief/resolve/main/assets/NisabaRelief-Logo.png" width="600"/>
 </div>
 
 
@@ -78,50 +78,50 @@ Named for Nisaba, the early Sumerian goddess of writing and scribes, NisabaRelie
 <tbody>
 
 <tr>
-  <td align="center"><img src="./assets/example_input_0.png" width="200"/></td>
-  <td align="center"><img src="./assets/example_output_0.png" width="200"/></td>
-  <td align="center"><img src="./assets/example_truth_0.png" width="200"/></td>
-  <td align="center"><img src="./assets/example_diff_0.png" width="200"/></td>
+  <td align="center"><img src="https://huggingface.co/boatbomber/NisabaRelief/resolve/main/assets/example_input_0.png" width="200"/></td>
+  <td align="center"><img src="https://huggingface.co/boatbomber/NisabaRelief/resolve/main/assets/example_output_0.png" width="200"/></td>
+  <td align="center"><img src="https://huggingface.co/boatbomber/NisabaRelief/resolve/main/assets/example_truth_0.png" width="200"/></td>
+  <td align="center"><img src="https://huggingface.co/boatbomber/NisabaRelief/resolve/main/assets/example_diff_0.png" width="200"/></td>
 </tr>
 <tr>
   <td colspan="4" align="center"><b>Dice: 0.9652</b> &nbsp;·&nbsp; RMSE: 0.0775 &nbsp;·&nbsp; MS-SSIM: 0.9295 &nbsp;·&nbsp; PSNR: 22.22 dB &nbsp;·&nbsp; PSNR-HVS-M: 17.77 dB &nbsp;·&nbsp; SRE: 58.34 dB</td>
 </tr>
 
 <tr>
-  <td align="center"><img src="./assets/example_input_1.png" width="200"/></td>
-  <td align="center"><img src="./assets/example_output_1.png" width="200"/></td>
-  <td align="center"><img src="./assets/example_truth_1.png" width="200"/></td>
-  <td align="center"><img src="./assets/example_diff_1.png" width="200"/></td>
+  <td align="center"><img src="https://huggingface.co/boatbomber/NisabaRelief/resolve/main/assets/example_input_1.png" width="200"/></td>
+  <td align="center"><img src="https://huggingface.co/boatbomber/NisabaRelief/resolve/main/assets/example_output_1.png" width="200"/></td>
+  <td align="center"><img src="https://huggingface.co/boatbomber/NisabaRelief/resolve/main/assets/example_truth_1.png" width="200"/></td>
+  <td align="center"><img src="https://huggingface.co/boatbomber/NisabaRelief/resolve/main/assets/example_diff_1.png" width="200"/></td>
 </tr>
 <tr>
   <td colspan="4" align="center"><b>Dice: 0.9555</b> &nbsp;·&nbsp; RMSE: 0.0788 &nbsp;·&nbsp; MS-SSIM: 0.9219 &nbsp;·&nbsp; PSNR: 22.07 dB &nbsp;·&nbsp; PSNR-HVS-M: 17.80 dB &nbsp;·&nbsp; SRE: 57.89 dB</td>
 </tr>
 
 <tr>
-  <td align="center"><img src="./assets/example_input_2.png" width="200"/></td>
-  <td align="center"><img src="./assets/example_output_2.png" width="200"/></td>
-  <td align="center"><img src="./assets/example_truth_2.png" width="200"/></td>
-  <td align="center"><img src="./assets/example_diff_2.png" width="200"/></td>
+  <td align="center"><img src="https://huggingface.co/boatbomber/NisabaRelief/resolve/main/assets/example_input_2.png" width="200"/></td>
+  <td align="center"><img src="https://huggingface.co/boatbomber/NisabaRelief/resolve/main/assets/example_output_2.png" width="200"/></td>
+  <td align="center"><img src="https://huggingface.co/boatbomber/NisabaRelief/resolve/main/assets/example_truth_2.png" width="200"/></td>
+  <td align="center"><img src="https://huggingface.co/boatbomber/NisabaRelief/resolve/main/assets/example_diff_2.png" width="200"/></td>
 </tr>
 <tr>
   <td colspan="4" align="center"><b>Dice: 0.9630</b> &nbsp;·&nbsp; RMSE: 0.1108 &nbsp;·&nbsp; MS-SSIM: 0.8513 &nbsp;·&nbsp; PSNR: 19.11 dB &nbsp;·&nbsp; PSNR-HVS-M: 14.65 dB &nbsp;·&nbsp; SRE: 59.60 dB</td>
 </tr>
 
 <tr>
-  <td align="center"><img src="./assets/example_input_3.png" width="200"/></td>
-  <td align="center"><img src="./assets/example_output_3.png" width="200"/></td>
-  <td align="center"><img src="./assets/example_truth_3.png" width="200"/></td>
-  <td align="center"><img src="./assets/example_diff_3.png" width="200"/></td>
+  <td align="center"><img src="https://huggingface.co/boatbomber/NisabaRelief/resolve/main/assets/example_input_3.png" width="200"/></td>
+  <td align="center"><img src="https://huggingface.co/boatbomber/NisabaRelief/resolve/main/assets/example_output_3.png" width="200"/></td>
+  <td align="center"><img src="https://huggingface.co/boatbomber/NisabaRelief/resolve/main/assets/example_truth_3.png" width="200"/></td>
+  <td align="center"><img src="https://huggingface.co/boatbomber/NisabaRelief/resolve/main/assets/example_diff_3.png" width="200"/></td>
 </tr>
 <tr>
   <td colspan="4" align="center"><b>Dice: 0.9713</b> &nbsp;·&nbsp; RMSE: 0.1035 &nbsp;·&nbsp; MS-SSIM: 0.8748 &nbsp;·&nbsp; PSNR: 19.70 dB &nbsp;·&nbsp; PSNR-HVS-M: 15.33 dB &nbsp;·&nbsp; SRE: 59.41 dB</td>
 </tr>
 
 <tr>
-  <td align="center"><img src="./assets/example_input_4.png" width="200"/></td>
-  <td align="center"><img src="./assets/example_output_4.png" width="200"/></td>
-  <td align="center"><img src="./assets/example_truth_4.png" width="200"/></td>
-  <td align="center"><img src="./assets/example_diff_4.png" width="200"/></td>
+  <td align="center"><img src="https://huggingface.co/boatbomber/NisabaRelief/resolve/main/assets/example_input_4.png" width="200"/></td>
+  <td align="center"><img src="https://huggingface.co/boatbomber/NisabaRelief/resolve/main/assets/example_output_4.png" width="200"/></td>
+  <td align="center"><img src="https://huggingface.co/boatbomber/NisabaRelief/resolve/main/assets/example_truth_4.png" width="200"/></td>
+  <td align="center"><img src="https://huggingface.co/boatbomber/NisabaRelief/resolve/main/assets/example_diff_4.png" width="200"/></td>
 </tr>
 <tr>
   <td colspan="4" align="center"><b>Dice: 0.9564</b> &nbsp;·&nbsp; RMSE: 0.1054 &nbsp;·&nbsp; MS-SSIM: 0.9325 &nbsp;·&nbsp; PSNR: 19.55 dB &nbsp;·&nbsp; PSNR-HVS-M: 15.18 dB &nbsp;·&nbsp; SRE: 57.36 dB</td>

hatch_build.py

@@ -0,0 +1,20 @@
+"""Hatch build hook to strip HuggingFace YAML frontmatter from README."""
+
+import re
+from pathlib import Path
+
+from hatchling.metadata.plugin.interface import MetadataHookInterface
+
+
+class ReadmeHook(MetadataHookInterface):
+    PLUGIN_NAME = "readme-strip-frontmatter"
+
+    def update(self, metadata: dict) -> None:
+        readme_path = Path(self.root) / "README.md"
+        text = readme_path.read_text(encoding="utf-8")
+        # Strip YAML frontmatter (--- ... ---)
+        text = re.sub(r"\A---\n.*?\n---\n*", "", text, count=1, flags=re.DOTALL)
+        metadata["readme"] = {
+            "content-type": "text/markdown",
+            "text": text,
+        }

pyproject.toml

@@ -2,6 +2,9 @@
 requires = ["hatchling"]
 build-backend = "hatchling.build"
 
+[tool.hatch.metadata.hooks.custom]
+path = "hatch_build.py"
+
 [tool.hatch.build.targets.sdist]
 exclude = ["*.safetensors", "assets/**", "data/**", "dev_scripts/**", "uv.lock"]
 
@@ -12,7 +15,7 @@ packages = ["nisaba_relief"]
 name = "nisaba-relief"
 version = "0.1.0"
 description = "Transform cuneiform tablet photos into MSII relief visualizations"
-readme = { file = "README.md", content-type = "text/markdown" }
+dynamic = ["readme"]
 license = "Apache-2.0"
 requires-python = ">=3.10,<3.14"
 authors = [{ name = "Zack Williams", email = "zack@boatbomber.com" }]