Added model card

README.md

@@ -1,3 +1,45 @@
 ---
-license: agpl-3.0
+license: OpenRAIL-M
 ---
+
+# Automated cell nuclei segmentation and classification
+
+Models of the [tumourkit](https://github.com/Jerry-Master/lung-tumour-study) library. The key idea behind these models is illustrated by the following image.
+
+![graph example](https://huggingface.co/Jerry-Master/Hovernet-plus-Graphs/resolve/main/examples/graph_overlay.png)
+
+The objective is to detect and classify cells of different tissues. Different models trained with tissue from different organs and stainings are provided. 
+
+## Lung (H&E)
+
+![lung example](https://huggingface.co/Jerry-Master/Hovernet-plus-Graphs/resolve/main/examples/lung_he.png)
+
+## Breast (HER2)
+
+![breast example](https://huggingface.co/Jerry-Master/Hovernet-plus-Graphs/resolve/main/examples/breast_her2.png)
+
+## Consep: Colorectal (H&E)
+
+![consep example](https://huggingface.co/Jerry-Master/Hovernet-plus-Graphs/resolve/main/examples/colorectal_he.png)
+
+## Monusac: Miscelaneous (H&E)
+
+![monusac example](https://huggingface.co/Jerry-Master/Hovernet-plus-Graphs/resolve/main/examples/monusac.png)
+
+## Model description
+
+The model is made by [Hovernet](https://github.com/vqdang/hover_net) as a backbone and a graph neural network on top to improve the classification step. Each backbone comes trained at two resolutions: 270x270 and 518x518. They also come in two version each, trained from scratch of fine-tuned from the consep checkpoint of Hovernet (FT). Then, for each Hovernet model, five graph neural networks. Four graph convolutional neural networks trained with different sets of features and one graph attention network trained with all the features.
+
+To use the models the tumourkit library comes with a simple [demo](https://lung-tumour-study.readthedocs.io/en/latest/usage.html#gradio-demo) that you can try. Beware, on CPU it takes nearly 10 minutes per 1024x1024 image.
+
+## Uses
+
+### Intended use
+
+The lung models are built to estimate the percentage of tumoural cells in a given whole slide image (WSI). It is supposed to be used to accelerate histologist work and give priorities among huge amounts of WSIs to analyse.
+
+The other three models are provided for research purposes only. 
+
+### Misuse
+
+By no means these models are supposed to substitute a medical expert, and they are not built for diagnosis. Usage in any critical situation is discouraged.