Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 1 addition & 3 deletions docs/version_2/image_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
layout: default
---

> **WARNING: This page is still in-progress, its contents may change based on the latest developments.**

While applying a processing workflow to a given dataset, Fractal keeps a list of all the OME-Zarr images it is processing. In this page we describe the concepts of [images](#images) and [filters](#filters) - see also the [examples section](#examples).

## Images
Expand All @@ -12,7 +10,7 @@ Each entry in the image list is defined by a unique `zarr_url` property (the ful

### Image types

Image types are boolean properties that allow to split the image list into different sub-lists (e.g. the `is_3D` type for 3D/2D images, or the `illumination_corrected` type for raw/corrected images when illumination correction was not run in-place). Types can be set both by the task manifest (e.g. after an MIP task, the resulting images always have the type `is_3D` set to `False` - see [task-manifest section](#dataset-filters)) as well as from within an individual task (see [task-API/output section](#output-api)).
Image types are boolean properties that allow to split the image list into different sub-lists (e.g. the `is_3D` type for 3D/2D images, or the `illumination_corrected` type for raw/corrected images when illumination correction was not run in-place). Types can be set both by the task manifest (e.g. after an MIP task, the resulting images always have the type `is_3D` set to `False` - see [task-manifest section](#dataset-filters)) as well as from within an individual task (see [task-API/output section](./tasks.md#output-api)).

Note: whenever applying filters to the image list, the absence of a type corresponds to false by default.

Expand Down
2 changes: 0 additions & 2 deletions docs/version_2/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,3 @@ This section describes the main concepts introduced with the new Fractal version

1. The [new dataset image list](./image_list.md);
2. The [new definition of tasks](./tasks.md).

> **WARNING: This page is still in-progress, its contents may change based on the latest developments.**
6 changes: 3 additions & 3 deletions docs/version_2/tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ layout: default

# Tasks

> **WARNING: This page is still in-progress, its contents may change based on the latest developments.**

Fractal v2 brings a large refactor to the task architecture to make tasks more flexible and allow for building more complex workflows, while also simplifying the task API. This page gives an overview over the different types of Fractal tasks, their input and output API and the elements that go into the Fractal task list.

## Task Types
Expand Down Expand Up @@ -42,7 +40,9 @@ Tasks can optionally return updates to the image list and/or [new dataset filter

For tasks that create new images or edit relevant image properties, `task_output` must include an `image_list_updates` property so the server can update its metadata about that image.

Task_outputs with image list updates are returned as a dictionary that contains the `image_list_updates` key and a list containing the updates to individual images. The updates need to be for unique `zarr_url`s and each update needs to contain the `zarr_url` of the image it’s providing an update for. Additionally, they can provide an `origin` key, an `attributes` key and a `types` key. The `origin` key describes the `zarr_url` of another image already in the image list and will take the existing attributes and types from that image. Attributes and types can also be directly set by a task.
> NOTE: if both `image_list_updates` and `image_list_removals` are empty, in the task output, then `fractal-server` includes all the filtered image list in `image_list_updates`, so that they are updated with the appropriate `types` (see also [the image-list page](./image_list.md#image-types)).

Task outputs with image list updates are returned as a dictionary that contains the `image_list_updates` key and a list containing the updates to individual images. The updates need to be for unique `zarr_url`s and each update needs to contain the `zarr_url` of the image it’s providing an update for. Additionally, they can provide an `origin` key, an `attributes` key and a `types` key. The `origin` key describes the `zarr_url` of another image already in the image list and will take the existing attributes and types from that image. Attributes and types can also be directly set by a task.

Here's an example of `task_output`:
```python
Expand Down