Sign in
classifier

Returns statistics of the dataset that would be created with these parameters

post/classifier/project/{proj_id}/dataset-statistics

Path parameters

proj_idinteger required

Request body

tag_idsinteger[] required

IDs of document tags that select the dataset's source documents

user_idsinteger[] required

IDs of annotators whose annotations should be used for sentence and span classification; ignored for document classification

merge_children_into_parentboolean required

Whether annotations of descendant codes should count toward their selected parent code; only applies to sentence and span classification

model'document' | 'sentence' | 'span' required
base_model_namestring required

Hugging Face base model selected for training. Span statistics use its tokenizer to align word annotations with model tokens; document and sentence statistics currently do not depend on it.

class_idsinteger[] required

Selected tag IDs for document classification or code IDs for sentence and span classification

Response

Successful Response

total_unitsinteger required

Total number of units (tokens / sentences / documents) in the dataset

labeled_unitsinteger required

Number of units with a non-O label in the dataset

signal_percentagenumber required

Percentage of labeled units relative to all units (training signal)

signal_strength'weak' | 'ok' | 'strong' required
weak_signal_thresholdnumber required

Signal percentage below which the training signal is considered weak

strong_signal_thresholdnumber required

Signal percentage above which the training signal is considered strong

unannotated_sdocsinteger[] required

IDs of tag-selected documents without a matching selected class. Span and sentence datasets exclude them; document datasets retain them as O examples

Changes

Changed in 2 of the 73 revisions of this API.12

  • 73fbdc0e5aa411See the full diff
    • ▲

      the request property merge_children_into_parent became required

      request-property-became-required

    • ○

      the merge_children_into_parent request property default value false was removed

      request-property-default-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • b102de952d8e1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog