Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Mar 6, 2024
1 parent 7d23a1c commit 180c893
Showing 1 changed file with 2 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -706,7 +706,7 @@

<dl class="py class">
<dt class="sig sig-object py" id="datumaro.plugins.configurable_validator.ConfigurableValidator">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datumaro.plugins.configurable_validator.</span></span><span class="sig-name descname"><span class="pre">ConfigurableValidator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">tasks:</span> <span class="pre">~typing.List[~datumaro.components.validator.TaskType]</span> <span class="pre">=</span> <span class="pre">[&lt;TaskType.classification:</span> <span class="pre">1&gt;,</span> <span class="pre">&lt;TaskType.detection:</span> <span class="pre">2&gt;,</span> <span class="pre">&lt;TaskType.segmentation:</span> <span class="pre">3&gt;],</span> <span class="pre">warnings:</span> <span class="pre">~typing.Set[~datumaro.components.errors.DatasetValidationError]</span> <span class="pre">=</span> <span class="pre">{&lt;class</span> <span class="pre">'datumaro.components.errors.OnlyOneAttributeValue'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.ImbalancedDistInLabel'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.FewSamplesInAttribute'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.FewSamplesInLabel'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.UndefinedAttribute'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.InvalidValue'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.FarFromAttrMean'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.AttributeDefinedButNotFound'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.OnlyOneLabel'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.ImbalancedLabels'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.MissingLabelCategories'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.LabelDefinedButNotFound'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.MissingAttribute'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.ImbalancedAttribute'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.UndefinedLabel'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.MultiLabelAnnotations'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.NegativeLength'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.ImbalancedDistInAttribute'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.MissingAnnotation'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.FarFromLabelMean'&gt;},</span> <span class="pre">few_samples_thr=None,</span> <span class="pre">imbalance_ratio_thr=None,</span> <span class="pre">far_from_mean_thr=None,</span> <span class="pre">dominance_ratio_thr=None,</span> <span class="pre">topk_bins=None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/datumaro/plugins/configurable_validator.html#ConfigurableValidator"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#datumaro.plugins.configurable_validator.ConfigurableValidator" title="Permalink to this definition">#</a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datumaro.plugins.configurable_validator.</span></span><span class="sig-name descname"><span class="pre">ConfigurableValidator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">tasks:</span> <span class="pre">~typing.List[~datumaro.components.validator.TaskType]</span> <span class="pre">=</span> <span class="pre">[&lt;TaskType.classification:</span> <span class="pre">1&gt;,</span> <span class="pre">&lt;TaskType.detection:</span> <span class="pre">2&gt;,</span> <span class="pre">&lt;TaskType.segmentation:</span> <span class="pre">3&gt;],</span> <span class="pre">warnings:</span> <span class="pre">~typing.Set[~datumaro.components.errors.DatasetValidationError]</span> <span class="pre">=</span> <span class="pre">{&lt;class</span> <span class="pre">'datumaro.components.errors.ImbalancedLabels'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.InvalidValue'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.AttributeDefinedButNotFound'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.MissingAttribute'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.LabelDefinedButNotFound'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.ImbalancedAttribute'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.MissingLabelCategories'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.OnlyOneAttributeValue'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.FarFromAttrMean'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.UndefinedAttribute'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.MultiLabelAnnotations'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.FewSamplesInLabel'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.MissingAnnotation'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.FarFromLabelMean'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.OnlyOneLabel'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.UndefinedLabel'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.NegativeLength'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.FewSamplesInAttribute'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.ImbalancedDistInLabel'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.ImbalancedDistInAttribute'&gt;},</span> <span class="pre">few_samples_thr=None,</span> <span class="pre">imbalance_ratio_thr=None,</span> <span class="pre">far_from_mean_thr=None,</span> <span class="pre">dominance_ratio_thr=None,</span> <span class="pre">topk_bins=None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/datumaro/plugins/configurable_validator.html#ConfigurableValidator"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#datumaro.plugins.configurable_validator.ConfigurableValidator" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="datumaro.components.validator.html#datumaro.components.validator.Validator" title="datumaro.components.validator.Validator"><code class="xref py py-class docutils literal notranslate"><span class="pre">Validator</span></code></a>, <a class="reference internal" href="datumaro.components.cli_plugin.html#datumaro.components.cli_plugin.CliPlugin" title="datumaro.components.cli_plugin.CliPlugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">CliPlugin</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="datumaro.plugins.configurable_validator.ConfigurableValidator.DEFAULT_FEW_SAMPLES_THR">
Expand Down Expand Up @@ -735,7 +735,7 @@

<dl class="py attribute">
<dt class="sig sig-object py" id="datumaro.plugins.configurable_validator.ConfigurableValidator.ALL_WARNINGS">
<span class="sig-name descname"><span class="pre">ALL_WARNINGS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'datumaro.components.errors.OnlyOneAttributeValue'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.ImbalancedDistInLabel'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.FewSamplesInAttribute'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.FewSamplesInLabel'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.UndefinedAttribute'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.InvalidValue'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.FarFromAttrMean'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.AttributeDefinedButNotFound'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.OnlyOneLabel'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.ImbalancedLabels'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.MissingLabelCategories'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.LabelDefinedButNotFound'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.MissingAttribute'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.ImbalancedAttribute'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.UndefinedLabel'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.MultiLabelAnnotations'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.NegativeLength'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.ImbalancedDistInAttribute'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.MissingAnnotation'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.FarFromLabelMean'&gt;}</span></em><a class="headerlink" href="#datumaro.plugins.configurable_validator.ConfigurableValidator.ALL_WARNINGS" title="Permalink to this definition">#</a></dt>
<span class="sig-name descname"><span class="pre">ALL_WARNINGS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'datumaro.components.errors.ImbalancedLabels'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.InvalidValue'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.AttributeDefinedButNotFound'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.MissingAttribute'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.LabelDefinedButNotFound'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.ImbalancedAttribute'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.MissingLabelCategories'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.OnlyOneAttributeValue'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.FarFromAttrMean'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.UndefinedAttribute'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.MultiLabelAnnotations'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.FewSamplesInLabel'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.MissingAnnotation'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.FarFromLabelMean'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.OnlyOneLabel'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.UndefinedLabel'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.NegativeLength'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.FewSamplesInAttribute'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.ImbalancedDistInLabel'&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'datumaro.components.errors.ImbalancedDistInAttribute'&gt;}</span></em><a class="headerlink" href="#datumaro.plugins.configurable_validator.ConfigurableValidator.ALL_WARNINGS" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>

<dl class="py method">
Expand Down

0 comments on commit 180c893

Please sign in to comment.