Improve documentation of IncludeWorkflows #40
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
glopesdev
reviewed
Jan 10, 2025
Comment on lines
+28
to
+38
| <Property Name="Fps" Description="The frames per second of the observations." Category="ModelParams" /> | ||
| <Property Name="Pos_x0" Description="The initial x position." Category="ModelParams" /> | ||
| <Property Name="Pos_y0" Description="The initial y position." Category="ModelParams" /> | ||
| <Property Name="Vel_x0" Description="The initial x velocity." Category="ModelParams" /> | ||
| <Property Name="Vel_y0" Description="The initial y velocity." Category="ModelParams" /> | ||
| <Property Name="Acc_x0" Description="The initial x acceleration." Category="ModelParams" /> | ||
| <Property Name="Acc_y0" Description="The initial y acceleration." Category="ModelParams" /> | ||
| <Property Name="Sigma_a" Description="A scalar value representing the measurement noise." Category="ModelParams" /> | ||
| <Property Name="Sigma_x" Description="A scalar value representing the prediction noise along the x axis." Category="ModelParams" /> | ||
| <Property Name="Sigma_y" Description="A scalar value representing the prediction noise along the y axis." Category="ModelParams" /> | ||
| <Property Name="Sqrt_diag_V0_value" Description="The initial value of the diagonal of the state covariance matrix." Category="ModelParams" /> |
There was a problem hiding this comment.
In general in Bonsai / C# we would use Pascal casing rather than snake case, but no need to change anything now, this is just a general comment for us to think about regarding casing of properties coming from Python.
| @@ -51,10 +51,10 @@ public class KFModelParameters | |||
| private string fpsString; | |||
|
|
|||
| /// <summary> | |||
| /// x position at time 0 | |||
| /// The initial x position. | |||
There was a problem hiding this comment.
Depending on casing we would change this to X but see comment above, no need to change anything now.
src/Bonsai.ML.LinearDynamicalSystems/Learning/CheckOptimizationFinished.bonsai
Outdated
Show resolved
Hide resolved
src/Bonsai.ML.LinearDynamicalSystems/Learning/RunOptimizationAsync.bonsai
Outdated
Show resolved
Hide resolved
ncguilbeault
force-pushed
the
dev/improve-documentation
branch
from
4f7f5c3 to
dcf81d2
Compare
ncguilbeault
force-pushed
the
dev/improve-documentation
branch
from
dcf81d2 to
614de1c
Compare
ncguilbeault
force-pushed
the
dev/improve-documentation
branch
from
614de1c to
712aa74
Compare
ncguilbeault
force-pushed
the
dev/improve-documentation
branch
from
712aa74 to
5266131
Compare
glopesdev
approved these changes
Mar 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR updates the main bonsai environment with the latest Bonsai.ML packages and adds documentation to IncludeWorkflows within Bonsai.ML packages. Fixes #32