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 description for IncludeWorkflow operators and ExternalizedMapping properties #32

Open
banchan86 opened this issue Nov 14, 2024 · 1 comment · May be fixed by #40
Open

Add description for IncludeWorkflow operators and ExternalizedMapping properties #32

banchan86 opened this issue Nov 14, 2024 · 1 comment · May be fixed by #40

Comments

@banchan86
Copy link

banchan86 commented Nov 14, 2024

While testing out a new patch that I am creating that will add support for Bonsai's IncludeWorkflow operators to docfx for documentation, I noticed that the IncludeWorkflow operators do not have a description for the operator or externalized properties.
For reference, check out the Bonvision IncludeWorkflow operators at https://github.com/bonvision/BonVision. Adding them will provide helpful information within the Bonsai editor and also help with future API documentation when the patch is ready.

Edit: upon closer inspection, I think the lack of externalized property descriptions might not be a problem it pulls fine from the embedded operators for most IncludeWorkflow Operators. I noted down these operators which could use ExternalizedMapping property descriptions:

Bonsai.ML.HiddenMarkovModels - RunFitAsync (missing description for all)
Bonsai.ML.LinearDynamicalSystems.Kinematics - PerformForecasting (missing description for Timestep)
Bonsai.ML.LinearDynamicalSystems.Learning - RunOptimizationAsync (missing description for all)

@ncguilbeault
Copy link
Collaborator

Thanks @banchan86 for looking into this. I'll start adding descriptions to the IncludeWorkflows/properties.

@ncguilbeault ncguilbeault linked a pull request Nov 20, 2024 that will close this issue
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 a pull request may close this issue.

2 participants