Skip to content

Commit cf459b2

Browse files
authored
rearange sections
1 parent cff0378 commit cf459b2

File tree

1 file changed

+35
-31
lines changed

1 file changed

+35
-31
lines changed

README.md

Lines changed: 35 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -288,17 +288,33 @@ The package is also available via pip
288288
pip install "bioimageio.core[onnx,pytorch]"
289289
```
290290

291-
### Set up Development Environment
291+
## 🐍 Use in Python
292292

293-
To set up a development conda environment run the following commands:
293+
`bioimageio.core` is a python package that implements prediction with bioimageio models
294+
including standardized pre- and postprocessing operations.
295+
These models are described by---and can be loaded with---the bioimageio.spec package.
294296

295-
```console
296-
conda env create -f dev/env.yaml
297-
conda activate core
298-
pip install -e . --no-deps
299-
```
297+
In addition bioimageio.core provides functionality to convert model weight formats.
300298

301-
There are different environment files available that only install tensorflow or pytorch as dependencies, see [dev folder](https://github.com/bioimage-io/core-bioimage-io-python/tree/main/dev).
299+
### Documentation
300+
[Here you find the bioimageio.core documentation.](https://bioimage-io.github.io/core-bioimage-io-python/bioimageio/core.html)
301+
302+
#### Presentations
303+
- [Create a model from scratch](https://bioimage-io.github.io/core-bioimage-io-python/presentations/create_ambitious_sloth.slides.html) ([source](https://github.com/bioimage-io/core-bioimage-io-python/tree/main/presentations))
304+
305+
#### Examples
306+
<dl>
307+
<dt>Notebooks that save and load resource descriptions and validate their format (using <a href="https://bioimage-io.github.io/core-bioimage-io-python/bioimageio/spec.html">bioimageio.spec</a>, a dependency of bioimageio.core)</dt>
308+
<dd><a href="https://github.com/bioimage-io/spec-bioimage-io/blob/main/example/load_model_and_create_your_own.ipynb">load_model_and_create_your_own.ipynb</a> <a target="_blank" href="https://colab.research.google.com/github/bioimage-io/spec-bioimage-io/blob/main/example/load_model_and_create_your_own.ipynb">
309+
<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
310+
</a></dd>
311+
<dd><a href="https://github.com/bioimage-io/spec-bioimage-io/blob/main/example/dataset_creation.ipynb">dataset_creation.ipynb</a> <a target="_blank" href="https://colab.research.google.com/github/bioimage-io/spec-bioimage-io/blob/main/example/dataset_creation.ipynb">
312+
<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
313+
</a></dd>
314+
<dt>Use the described resources in Python with <a href="https://bioimage-io.github.io/core-bioimage-io-python/bioimageio/core.html">bioimageio.core</a></dt>
315+
<dd><a href="https://github.com/bioimage-io/core-bioimage-io-python/blob/main/example/model_usage.ipynb">model_usage.ipynb</a><a target="_blank" href="https://colab.research.google.com/github/bioimage-io/core-bioimage-io-python/blob/main/example/model_usage.ipynb">
316+
<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
317+
</dl>
302318

303319
## 💻 Use the Command Line Interface
304320

@@ -309,6 +325,9 @@ You can list all the available commands via:
309325
bioimageio
310326
```
311327

328+
For examples see [Getting started](#get-started).
329+
330+
312331
### CLI inputs from file
313332

314333
For convenience the command line options (not arguments) may be given in a `bioimageio-cli.json`
@@ -323,33 +342,18 @@ blockwise: true
323342
stats: inputs/dataset_statistics.json
324343
```
325344
326-
## 🐍 Use in Python
327-
328-
`bioimageio.core` is a python package that implements prediction with bioimageio models
329-
including standardized pre- and postprocessing operations.
330-
These models are described by---and can be loaded with---the bioimageio.spec package.
331345
332-
In addition bioimageio.core provides functionality to convert model weight formats.
346+
## Set up Development Environment
333347
334-
### Documentation
335-
[Here you find the bioimageio.core documentation.](https://bioimage-io.github.io/core-bioimage-io-python/bioimageio/core.html)
348+
To set up a development conda environment run the following commands:
336349
337-
#### Presentations
338-
- [Create a model from scratch](https://bioimage-io.github.io/core-bioimage-io-python/presentations/create_ambitious_sloth.slides.html) ([source](https://github.com/bioimage-io/core-bioimage-io-python/tree/main/presentations))
350+
```console
351+
conda env create -f dev/env.yaml
352+
conda activate core
353+
pip install -e . --no-deps
354+
```
339355

340-
#### Examples
341-
<dl>
342-
<dt>Notebooks that save and load resource descriptions and validate their format (using <a href="https://bioimage-io.github.io/core-bioimage-io-python/bioimageio/spec.html">bioimageio.spec</a>, a dependency of bioimageio.core)</dt>
343-
<dd><a href="https://github.com/bioimage-io/spec-bioimage-io/blob/main/example/load_model_and_create_your_own.ipynb">load_model_and_create_your_own.ipynb</a> <a target="_blank" href="https://colab.research.google.com/github/bioimage-io/spec-bioimage-io/blob/main/example/load_model_and_create_your_own.ipynb">
344-
<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
345-
</a></dd>
346-
<dd><a href="https://github.com/bioimage-io/spec-bioimage-io/blob/main/example/dataset_creation.ipynb">dataset_creation.ipynb</a> <a target="_blank" href="https://colab.research.google.com/github/bioimage-io/spec-bioimage-io/blob/main/example/dataset_creation.ipynb">
347-
<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
348-
</a></dd>
349-
<dt>Use the described resources in Python with <a href="https://bioimage-io.github.io/core-bioimage-io-python/bioimageio/core.html">bioimageio.core</a></dt>
350-
<dd><a href="https://github.com/bioimage-io/core-bioimage-io-python/blob/main/example/model_usage.ipynb">model_usage.ipynb</a><a target="_blank" href="https://colab.research.google.com/github/bioimage-io/core-bioimage-io-python/blob/main/example/model_usage.ipynb">
351-
<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
352-
</dl>
356+
There are different environment files available that only install tensorflow or pytorch as dependencies, see [dev folder](https://github.com/bioimage-io/core-bioimage-io-python/tree/main/dev).
353357

354358

355359
## Logging level

0 commit comments

Comments
 (0)