Skip to content

Commit 9bbc3c4

Browse files
committed
update README.md
1 parent 715befb commit 9bbc3c4

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

+10-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# core-bioimage-io-python
22

3-
Python specific core utilities for running models in the [BioImage Model Zoo](https://bioimage.io).
3+
Python specific core utilities for [bioimage.io]("https://bioimage.io") resources (in particular models).
44

55
## Installation
66

@@ -67,7 +67,7 @@ mamba activate core
6767
pip install -e . --no-deps
6868
```
6969

70-
There are different environment files that only install tensorflow or pytorch as dependencies available.
70+
There are different environment files available that only install tensorflow or pytorch as dependencies.
7171

7272
## 💻 Command Line
7373

@@ -106,12 +106,15 @@ bioimagei predict-images -m <MODEL> -i <INPUT_PATTERN> - o <OUTPUT_FOLDER>
106106

107107
## From python
108108

109-
`bioimageio.core` is a python library that implements loading models, running prediction with them and more.
110-
To get an overview of this functionality, check out the example notebooks:
109+
`bioimageio.core` is a python package that implements prediction with bioimageio models
110+
including standardized pre- and postprocessing operations.
111+
These models are described by---and can be loaded with---the bioimageio.spec package.
111112

112-
* [example/model_usage](https://github.com/bioimage-io/core-bioimage-io-python/blob/main/example/model_usage.ipynb) for how to load models and run prediction with them
113-
* [example/model_creation](https://github.com/bioimage-io/core-bioimage-io-python/blob/main/example/model_creation.ipynb) for how to create bioimage.io compatible model packages
114-
* [example/dataset_statistics_demo](https://github.com/bioimage-io/core-bioimage-io-python/blob/main/example/dataset_statistics_demo.ipynb) for how to use the dataset statistics for advanced pre-and-postprocessing
113+
In addition bioimageio.core provides functionality to convert model weight formats.
114+
115+
To get an overview of this functionality, check out these example notebooks:
116+
117+
* [model creation/loading with bioimageio.spec](https://github.com/bioimage-io/spec-bioimage-io/blob/main/example_use/load_model_and_create_your_own.ipynb)
115118

116119
## Model Specification
117120

0 commit comments

Comments
 (0)