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.

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

Upd batch #230

Merged
merged 6 commits into from
Feb 27, 2023
Merged

Upd batch #230

merged 6 commits into from
Feb 27, 2023

Conversation

k-dominik
Copy link
Contributor

@k-dominik k-dominik commented Feb 21, 2023

Batch processing docs were quite outdated, referencing steps that were just not there anymore.

Summary:

  • updated images
  • adapted text to current (1.4.0) gui state
  • added an FAQ, inspired by forum posts we get

fixes #64

@k-dominik k-dominik marked this pull request as ready for review February 21, 2023 16:08
@k-dominik k-dominik requested a review from btbest February 21, 2023 16:08
Copy link
Contributor

@btbest btbest left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some minor phrasing suggestions.

documentation/basics/batch.md Outdated Show resolved Hide resolved
documentation/basics/batch.md Outdated Show resolved Hide resolved
documentation/basics/batch.md Outdated Show resolved Hide resolved
documentation/basics/batch.md Outdated Show resolved Hide resolved
The next step is the actual batch processing itself. In the **Batch Prediction Output Locations** applet, the user can configure the output format using the **Choose Settings** button. This allow for example to save the results of the workflow as `.png` images rather than `.tiff` or `.h5` files. For novice users the default settings should be fine, however the results of some workflows such as the [density counting workflow]({{site.baseurl}}/documentation/counting/counting.html) cannot be exported in some of these formats (**hdf5 file format is supported by all workflows**).
#### How do I specify the internal dataset in a `.hdf5`/`.z5`-file?
It is currently not possible to specify the internal dataset with the graphical user interface, use the [headless mode][headless], or [Fiji plugin](https://github.com/ilastik/ilastik4ij#ilastik-imagej-modules) to process that data.
Alternatively you could create `hdf5` files with only single virtual dataset each, that point to the file that has multiple ones.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't follow how this suggestion achieves "specifying the internal dataset". Are we asking the user to wrap the batch processing output in another h5?

Copy link
Contributor Author

@k-dominik k-dominik Feb 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, maybe that's a tad too advanced... So in h5 there is the concept of virtual datasets. So what I'm suggesting is to create one for each of the internal paths - such h5 files would appear as if there were only a single dataset. I'll scratch that remark, and wait until such a question actually comes up (in the forum) or we devote some time on improving the ui :)

documentation/basics/batch.md Outdated Show resolved Hide resolved
@k-dominik
Copy link
Contributor Author

thank you @btbest for the great suggestions 🙌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

batch processing docs should mention wildcards
2 participants