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

[Documentation] Improve pipeline documentation #1273

Open
russelldj opened this issue Apr 14, 2021 · 1 comment
Open

[Documentation] Improve pipeline documentation #1273

russelldj opened this issue Apr 14, 2021 · 1 comment
Assignees
Labels
clean-up This is not a bug, but could use simplifying or tidying up enhancement

Comments

@russelldj
Copy link
Contributor

russelldj commented Apr 14, 2021

The pipeline documentation seems quite obtuse to me. Since this seems like a primary way end users would interact with KWIVER, it seems worthwhile to make it both more accessible and easier to read. For example, I'm still confused on the exact taxonomy of a process block and my read of this doc does little to address my questions. Perhaps starting with that and other basics, like how to use the pipeline runner and plugin_explorer, would be more useful. It seems like then many of these current topics could land in an Advanced section, or something analogous.

@russelldj russelldj added clean-up This is not a bug, but could use simplifying or tidying up enhancement labels Apr 14, 2021
@russelldj
Copy link
Contributor Author

russelldj commented Apr 14, 2021

I guess I was roughly looking for the process definition section, which is sort of buried in other stuff. It also doesn't explain how to use the type specifier, which seems to some times be prefaced with a different name than the algorithm type. E.g., an image_filter type would be specified as filter:type.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clean-up This is not a bug, but could use simplifying or tidying up enhancement
Projects
None yet
Development

No branches or pull requests

2 participants