Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
FynnBe committed Apr 26, 2024
1 parent 6df79a7 commit 5dc6b3a
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# core-bioimage-io-python

Python specific core utilities for [bioimage.io]("https://bioimage.io") resources (in particular models).
Python specific core utilities for bioimage.io resources (in particular models).

## Installation

Expand Down Expand Up @@ -69,7 +69,7 @@ pip install -e . --no-deps

There are different environment files available that only install tensorflow or pytorch as dependencies.

## 💻 Command Line
## 💻 Use the Command Line Interface

`bioimageio.core` installs a command line interface (CLI) for testing models and other functionality.
You can list all the available commands via:
Expand Down Expand Up @@ -104,7 +104,7 @@ bioimagei predict-images -m <MODEL> -i <INPUT_PATTERN> - o <OUTPUT_FOLDER>

`<INPUT_PATTERN>` is a `glob` pattern to select the desired images, e.g. `/path/to/my/images/*.tif`.

## 🐍 From python
## 🐍 Use in Python

`bioimageio.core` is a python package that implements prediction with bioimageio models
including standardized pre- and postprocessing operations.
Expand All @@ -116,6 +116,8 @@ To get an overview of this functionality, check out these example notebooks:

* [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)

and the [developer documentation](https://bioimage-io.github.io/core-bioimage-io-python/bioimageio/core.html).

## Model Specification

The model specification and its validation tools can be found at <https://github.com/bioimage-io/spec-bioimage-io>.
Expand Down

0 comments on commit 5dc6b3a

Please sign in to comment.