Bump version to v0.1.1, add model zoo

README.rst

@@ -0,0 +1,24 @@
+AI for Oncology Core for Computational Pathology
+================================================
+
+.. image:: https://github.com/NKI-AI/ahcore/actions/workflows/precommit_checks.yml/badge.svg
+   :target: https://github.com/NKI-AI/ahcore/actions/workflows/precommit_checks.yml
+
+.. image:: https://codecov.io/gh/NKI-AI/ahcore/branch/main/graph/badge.svg?token=OIJ7F9G7OO
+   :target: https://codecov.io/gh/NKI-AI/ahcore
+
+Ahcore are the `AI for Oncology <https://aiforoncology.nl>`_ core components for computational pathology. It provides a set of tools for working with pathology images and annotations. It also offers standard computational pathology algorithms.
+
+Check the `full documentation <https://docs.aiforoncology.nl/ahcore>`_ for more details on how to use ahcore.
+
+License and Usage
+-----------------
+
+Ahcore is not intended for clinical use. It is licensed under the `Apache License 2.0 <https://www.apache.org/licenses/LICENSE-2.0>`_.
+
+Included Models
+---------------
+
+Ahcore comes with several models included, check the `model zoo <https://docs.aiforoncology.nl/ahcore/model_zoo.html>`_ for more information:
+
+- Tissue/background segmentation in H&Es

docs/index.rst

@@ -11,6 +11,7 @@ AI for Oncology Core for Computational Pathology
 
    cli
    configuration
+   model_zoo
    contributing
    modules
 

docs/model_zoo.rst

@@ -0,0 +1,38 @@
+.. role:: raw-html-m2r(raw)
+   :format: html
+
+
+Model Zoo and Baselines
+=======================
+
+Introduction
+------------
+
+This file documents models associated with the ahcore project. You can download the parameters and weights of these
+models, provided as a zip file.
+
+License
+-------
+
+All models made available through this page are licensed under the\ :raw-html-m2r:`<br>`
+`Creative Commons Attribution-ShareAlike 3.0 license <https://creativecommons.org/licenses/by-sa/3.0/>`_.
+
+Baselines
+---------
+
+Segmentation models
+^^^^^^^^^^^^^^^^^^^
+
+.. list-table::
+   :header-rows: 1
+
+   * - Model
+     - Tissue type
+     - Staining
+     - Checkpoint
+     - Version
+   * - U-net
+     - pancancer
+     - H&E
+     - `download <https://files.aiforoncology.nl/ahcore/v0.1.1/tissue_background.zip>`_
+     - v0.1.1

setup.py

@@ -12,7 +12,7 @@
             break
 
 
-with open("README.md") as readme_file:
+with open("README.rst") as readme_file:
     long_description = readme_file.read()
 
 install_requires = [
@@ -42,7 +42,6 @@
 setup(
     author="AI for Oncology Lab @ The Netherlands Cancer Institute",
     long_description=long_description,
-    long_description_content_type="text/markdown",
     python_requires=">=3.10",
     classifiers=[
         "Development Status :: 4 - Beta",