[Doc] Add custom metrics document #2799
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
MeowZheng
reviewed
Mar 28, 2023
|
|
||
| 在上面的示例中，`CustomMetric` 是 `BaseMetric` 的子类。它有三个方法：`process`，`compute_metrics` 和 `evaluate`。 | ||
|
|
||
| - `process()` 处理一批数据样本和预测。处理后的结果存储在 `self.results` 中，将在处理所有数据样本后用于计算指标。 |
There was a problem hiding this comment.
Suggested change
| - `process()` 处理一批数据样本和预测。处理后的结果存储在 `self.results` 中，将在处理所有数据样本后用于计算指标。 | |
| - `process()` 处理一批数据样本和预测。处理后的结果需要显示地传给 `self.results` ，将在处理所有数据样本后用于计算指标。更多细节请参考 [MMEngine 文档](https://github.com/open-mmlab/mmengine/blob/main/docs/zh_cn/design/evaluation.md) |
csatsurnh
reviewed
Mar 30, 2023
Comment on lines
+21
to
+26
| """ | ||
| The metric first processes each batch of data_samples and predictions, | ||
| and appends the processed results to the results list. Then it | ||
| collects all results together from all ranks if distributed training | ||
| is used. Finally, it computes the metrics of the entire dataset. | ||
| """ |
There was a problem hiding this comment.
Suggested change
| """ | |
| The metric first processes each batch of data_samples and predictions, | |
| and appends the processed results to the results list. Then it | |
| collects all results together from all ranks if distributed training | |
| is used. Finally, it computes the metrics of the entire dataset. | |
| """ | |
| pass |
might not need the docstring?
There was a problem hiding this comment.
I think it needs a brief introduction to the evaluation process.
Comment on lines
+21
to
+26
| """ | ||
| The metric first processes each batch of data_samples and predictions, | ||
| and appends the processed results to the results list. Then it | ||
| collects all results together from all ranks if distributed training | ||
| is used. Finally, it computes the metrics of the entire dataset. | ||
| """ |
Co-authored-by: CSH <[email protected]>
csatsurnh
approved these changes
Mar 30, 2023
nahidnazifi87
pushed a commit
to nahidnazifi87/mmsegmentation_playground
that referenced
this pull request
Apr 5, 2024
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.
Motivation
As title
Modification