Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

minor style changes in readme #44

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

minor style changes in readme #44

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,15 @@

All the functionalities are grouped under a user-friendly API.

If you encounter any issue or have questions regarding the library, feel free to [open a GitHub issue](add_link). We'll do our best to address it.
If you encounter any issue or have questions regarding the library, feel free to [open a GitHub issue](https://github.com/BiomedSciAI/histocartography/issues/new). We'll do our best to address it.

# Installation

## PyPI installer (recommended)

`pip install histocartography`
```
pip install histocartography
```

## Development setup

Expand Down Expand Up @@ -71,7 +73,7 @@ The `histocartography` library provides a set of helpers grouped in different mo

For instance, in `histocartography.preprocessing`, building a cell-graph from an H&E image is as simple as:

```
```python
>> from histocartography.preprocessing import NucleiExtractor, DeepFeatureExtractor, KNNGraphBuilder
>>
>> nuclei_detector = NucleiExtractor()
Expand All @@ -86,7 +88,7 @@ For instance, in `histocartography.preprocessing`, building a cell-graph from an

The output can be then visualized with:

```
```python
>> from histocartography.visualization import OverlayGraphVisualization, InstanceImageVisualization

>> visualizer = OverlayGraphVisualization(
Expand Down Expand Up @@ -132,7 +134,7 @@ A tutorial with detailed descriptions and visualizations of some of the main fun

If you use this library, please consider citing:

```
```bibtex
@inproceedings{jaume2021,
title = {HistoCartography: A Toolkit for Graph Analytics in Digital Pathology},
author = {Guillaume Jaume, Pushpak Pati, Valentin Anklin, Antonio Foncubierta, Maria Gabrani},
Expand Down