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

Add object feature documentation #220

Merged
merged 5 commits into from
Nov 15, 2022
Merged

Add object feature documentation #220

merged 5 commits into from
Nov 15, 2022

Conversation

k-dominik
Copy link
Contributor

@k-dominik k-dominik commented Nov 3, 2022

Todos:

  • aggregate features that are present at multiple "dims"
  • maybe group table by feature plugin
  • convex hull features: 2d/3d are the same (docstrings at least), should only list one group
  • reorder (Standard first, then the others).
    the idea here being that in future we maintain an additional json file (or similar) that we'd merge with the auto-generated documentation to add further information via scripts/generate_base_oc_feat_info.py (this is not implemented in the PR at hand).

it still looks kind of raw :/

you can check the deploy preview: https://deploy-preview-220--ilastik.netlify.app/documentation/objects/featuretable

fixes #65

@k-dominik k-dominik force-pushed the oc-feat-doc branch 28 times, most recently from f6339c4 to b9933f1 Compare November 4, 2022 13:55
@k-dominik k-dominik marked this pull request as ready for review November 4, 2022 14:46
@k-dominik k-dominik requested a review from akreshuk November 4, 2022 14:46
@k-dominik k-dominik force-pushed the oc-feat-doc branch 2 times, most recently from 97fd179 to a1fbe62 Compare November 7, 2022 09:22
@k-dominik
Copy link
Contributor Author

after thinking more about it I propose we handle all doc content for the object features in respective plugins. Having additional stuff here is brittle and bound to break. Also - apart from the docs in the ilastik feature selection applet being somewhat limited to text - any additional information is probably useful there as well.

@k-dominik k-dominik force-pushed the oc-feat-doc branch 5 times, most recently from 1043959 to bdaa55d Compare November 9, 2022 07:54
@k-dominik k-dominik merged commit 92f4e6c into main Nov 15, 2022
@k-dominik k-dominik deleted the oc-feat-doc branch November 15, 2022 13:37
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.

Document object features
1 participant