Skip to content

docs: additional context for evidence_update_threshold #188

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

Merged
merged 3 commits into from
Feb 26, 2025

Conversation

tristanls
Copy link
Contributor

@vkakerbeck gave this explanation for evidence_update_threshold in a video. This explanation is what clicked for me and apparently @scottcanoe. This pull request adds it for context for others who try to understand the purpose of this parameter.

@tristanls tristanls requested a review from vkakerbeck February 25, 2025 15:32
@tristanls tristanls added documentation Improvements or additions to documentation triaged This issue or pull request was triaged labels Feb 25, 2025
Copy link
Contributor

@vkakerbeck vkakerbeck left a comment

Choose a reason for hiding this comment

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

Thanks for adding the clarification! Just one note: Only the '[int]%' and 'x_percent_threshold' options look at the evidence of the MLH. The other options would set a fixed threshold that doesn't take the evidence of the MLH into account. (or a varying threshold in the case of 'mean' and 'median' which take all evidences for all hypotheses into account)

@tristanls
Copy link
Contributor Author

Thank you @vkakerbeck, updated.

@tristanls tristanls requested a review from vkakerbeck February 25, 2025 23:44
Copy link
Contributor

@vkakerbeck vkakerbeck left a comment

Choose a reason for hiding this comment

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

Looks good, thank you! I just added a suggested edit to make it clear that we look at the evidence for the mlh, not the mlh itself (object ID and pose)

Comment on lines 179 to 185
When this parameter is either '[int]%' or 'x_percent_threshold`, then
this parameter is applied to the Most Likely Hypothesis (MLH) to
determine a minimum evidence threshold in order for other hypotheses to be
updated. Any hypotheses falling below the resulting evidence threshold do
not get updated. The other options set a fixed threshold that does not
take MLH into account.In [int, float, '[int]%', 'mean', 'median', 'all',
'x_percent_threshold'].
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
When this parameter is either '[int]%' or 'x_percent_threshold`, then
this parameter is applied to the Most Likely Hypothesis (MLH) to
determine a minimum evidence threshold in order for other hypotheses to be
updated. Any hypotheses falling below the resulting evidence threshold do
not get updated. The other options set a fixed threshold that does not
take MLH into account.In [int, float, '[int]%', 'mean', 'median', 'all',
'x_percent_threshold'].
When this parameter is either '[int]%' or 'x_percent_threshold`, then
this parameter is applied to the evidence for the Most Likely Hypothesis (MLH)
to determine a minimum evidence threshold in order for other hypotheses to be
updated. Any hypotheses falling below the resulting evidence threshold do
not get updated. The other options set a fixed threshold that does not
take MLH evidence into account. In [int, float, '[int]%', 'mean', 'median', 'all',
'x_percent_threshold'].

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you, I added this as well 👍.

@tristanls tristanls enabled auto-merge (squash) February 26, 2025 08:57
@tristanls tristanls merged commit 1383e9d into thousandbrainsproject:main Feb 26, 2025
13 checks passed
nielsleadholm pushed a commit to nielsleadholm/tbp.monty that referenced this pull request Mar 3, 2025
@tristanls tristanls deleted the evidence_docstring branch June 27, 2025 23:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation triaged This issue or pull request was triaged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants