Code Documentation¶
unitxt package¶
Subpackages¶
- unitxt.service package
- unitxt.test_utils package
- unitxt.ui package
Submodules¶
- unitxt.api module
- unitxt.artifact module
ArtifactArtifact.from_dict()Artifact.get_artifact_type()Artifact.get_pretty_print_name()Artifact.is_artifact_dict()Artifact.is_artifact_file()Artifact.is_registered_class()Artifact.is_registered_class_name()Artifact.is_registered_type()Artifact.load()Artifact.prepare()Artifact.process_data_after_load()Artifact.process_data_before_dump()Artifact.register_class()Artifact.save()Artifact.serialize()Artifact.to_json()Artifact.verify()Artifact.verify_artifact_dict()Artifact.verify_data_classification_policy()Artifact.verify_instance()
ArtifactListArtifactoriesArtifactoryMissingArtifactTypeErrorUnitxtArtifactNotFoundErrorUnrecognizedArtifactTypeErrorfetch_artifact()get_artifactory_name_and_args()get_artifacts_data_classification()get_closest_artifact_type()get_raw()is_name_legal_for_catalog()map_values_in_place()maybe_recover_artifact()register_all_artifacts()reset_artifacts_json_cache()verbosed_fetch_artifact()verify_legal_catalog_name()
- unitxt.blocks module
- unitxt.card module
- unitxt.catalog module
- unitxt.collections module
- unitxt.collections_operators module
- unitxt.dataclass module
AbstractFieldAbstractFieldErrorDataclassDataclassMetaDeprecatedFieldFieldFinalFieldFinalFieldErrorInternalFieldMissingDefaultErrorNonPositionalFieldOptionalFieldRequiredFieldRequiredFieldErrorTypeMismatchErrorUndefinedUnexpectedArgumentErrorabstract_fields()asdict()class_fields()deprecated_fields()fields()fields_names()final_fields()get_field_default()get_fields()is_abstract_field()is_class_method()is_dataclass()is_deprecated_field()is_final_field()is_possible_field()required_fields()
- unitxt.dataset module
- unitxt.dataset_utils module
- unitxt.deprecation_utils module
- unitxt.dialog_operators module
- unitxt.dict_utils module
- unitxt.eval_utils module
- unitxt.file_utils module
- unitxt.formats module
- unitxt.fusion module
- unitxt.generator_utils module
- unitxt.hf_utils module
- unitxt.inference module
- unitxt.instructions module
- unitxt.llm_as_judge module
- unitxt.loaders module
- unitxt.logging_utils module
- unitxt.metric module
- unitxt.metric_utils module
- unitxt.metrics module
AccuracyBertScoreBinaryAccuracyBinaryMaxAccuracyBinaryMaxF1BulkInstanceMetricCharEditDistanceCharEditDistanceAccuracyCustomF1CustomF1FuzzyDetectorF1F1BinaryF1BinaryPosOnlyF1MacroF1MacroMultiLabelF1MicroF1MicroMultiLabelF1MultiLabelF1WeightedFinQAEvalFixedGroupAbsvalNormCohensHParaphraseAccuracyFixedGroupAbsvalNormCohensHParaphraseStringContainmentFixedGroupAbsvalNormHedgesGParaphraseAccuracyFixedGroupAbsvalNormHedgesGParaphraseStringContainmentFixedGroupMeanAccuracyFixedGroupMeanBaselineAccuracyFixedGroupMeanBaselineStringContainmentFixedGroupMeanParaphraseAccuracyFixedGroupMeanParaphraseStringContainmentFixedGroupMeanStringContainmentFixedGroupNormCohensHParaphraseAccuracyFixedGroupNormCohensHParaphraseStringContainmentFixedGroupNormHedgesGParaphraseAccuracyFixedGroupNormHedgesGParaphraseStringContainmentFixedGroupPDRParaphraseAccuracyFixedGroupPDRParaphraseStringContainmentFuzzyNerGlobalMetricGroupMeanAccuracyGroupMeanStringContainmentGroupMeanTokenOverlapHuggingfaceBulkMetricHuggingfaceInstanceMetricHuggingfaceMetricInstanceMetricIsCodeMixedJaccardIndexKPAKendallTauMetricLlamaIndexCorrectnessLlamaIndexFaithfulnessLlamaIndexLLMMetricMAPMRRMatthewsCorrelationMaxAccuracyMeteorMetricMetricPipelineMetricWithConfidenceIntervalMetricsEnsembleNDCGNERNormalizedSacrebleuPerplexityPrecisionBinaryPrecisionMacroMultiLabelPrecisionMicroMultiLabelRecallBinaryRecallMacroMultiLabelRecallMicroMultiLabelRegardMetricRemoteMetricRerankRecallRetrievalAtKRetrievalMetricRewardRocAucRougeRougeHFSafetyMetricSentenceBertSpearmanrSquadStringContainmentTokenOverlapUnsortedListExactMatchUpdateStreamWeightedWinRateCorrelationWerabstract_factory()abstract_field()interpret_effect_size()mean_subgroup_score()nan_max()nan_mean()normalize_answer()normalized_cohens_h()normalized_hedges_g()parse_string_types_instead_of_actual_objects()performance_drop_rate()pytrec_eval_at_k()validate_subgroup_types()
- unitxt.normalizers module
- unitxt.operator module
BaseFieldOperatorInstanceOperatorInstanceOperatorValidatorInstanceOperatorWithMultiStreamAccessMissingRequirementsErrorMultiStreamOperatorOperatorOperatorErrorPackageRequirementsMixinPagedStreamOperatorSequentialMixinSequentialOperatorSequentialOperatorInitializerSideEffectOperatorSingleStreamOperatorSingleStreamReducerSourceOperatorSourceSequentialOperatorStreamInitializerOperatorStreamOperatorStreamingOperatorinstance_generator()stream_single()
- unitxt.operators module
- Operators: Building Blocks of Unitxt Processing Pipelines
AddConstantAddIDApplyApplyMetricApplyOperatorsFieldApplyStreamOperatorsFieldArtifactFetcherMixinAugmentPrefixSuffixAugmentWhitespaceAugmentorCastFieldsComputeExpressionMixinCopyDeterministicBalancerDivideAllFieldsByDownloadErrorDownloadOperatorDuplicateInstancesEncodeLabelsExecuteExpressionExtractFieldValuesExtractMostCommonFieldValuesExtractZipFileFeatureGroupedShuffleFieldOperatorFilterByConditionFilterByConditionBasedOnFieldsFilterByExpressionFlattenInstancesFromIterablesGetItemByIndexIndexOfInstanceFieldOperatorInterleaveListsToDialogOperatorIntersectIterableSourceJoinStrLengthBalancerListFieldValuesMapInstanceValuesMergeStreamsMinimumOneExamplePerLabelRefinerNullAugmentorPerturbRemoveFieldsRemoveValuesRenameFieldsSelectFieldsSetShuffleShuffleFieldValuesSplitByNestedGroupSplitByValueStreamRefinerTakeByFieldUnexpectedHttpCodeErrorUniqueZipFieldValues
- unitxt.parsing_utils module
- unitxt.processors module
CapitalizeConvertToBooleanDictOfListsToPairsExtractArenaHardNumericalJudgmentExtractMtBenchLabelJudgmentExtractMtBenchRatingJudgmentExtractSafeUnsafeJudgmentExtractWithRegexFirstCharacterGetStringAfterListToEmptyEntitiesTuplesLiteralEvalLowerCaseLowerCaseTillPuncMatchClosestOptionRegexParserSplitStripStanceToProConStrToFloatFormatStringOrNotStringSubstringTakeFirstNonEmptyLineTakeFirstWordToListByCommaToListByCommaSpaceToStringToStringStrippedToYesOrNoneYesNoToIntYesToOneElseZeroprocess_instance_value()
- unitxt.random_utils module
- unitxt.recipe module
- unitxt.register module
- unitxt.schema module
- unitxt.settings_utils module
- unitxt.span_lableing_operators module
- unitxt.split_utils module
- unitxt.splitters module
- unitxt.standard module
AddDemosFieldBaseRecipeCreateDemosPoolStandardRecipeStandardRecipe.cardStandardRecipe.templateStandardRecipe.system_promptStandardRecipe.loader_limitStandardRecipe.formatStandardRecipe.metricsStandardRecipe.postprocessorsStandardRecipe.train_refinerStandardRecipe.max_train_instancesStandardRecipe.validation_refinerStandardRecipe.max_validation_instancesStandardRecipe.test_refinerStandardRecipe.max_test_instancesStandardRecipe.demos_pool_sizeStandardRecipe.num_demosStandardRecipe.demos_pool_nameStandardRecipe.demos_taken_fromStandardRecipe.demos_fieldStandardRecipe.demos_removed_from_dataStandardRecipe.samplerStandardRecipe.stepsStandardRecipe.augmentorStandardRecipe.instruction_card_indexStandardRecipe.template_card_indexStandardRecipe.prepare()
StandardRecipeWithIndexes
- unitxt.stream module
- unitxt.stream_operators module
- unitxt.string_operators module
- unitxt.struct_data_operators module
ConvertTableColNamesToSequentialDumpJsonListToKeyValPairsLoadJsonMapHTMLTableToJSONMapTableListsToStdTableJSONSerializeKeyValPairsSerializeTableSerializeTableAsDFLoaderSerializeTableAsIndexedRowMajorSerializeTableAsJsonSerializeTableAsMarkdownSerializeTableRowAsListSerializeTableRowAsTextSerializeTriplesShuffleTableColumnsShuffleTableRowsTruncateTableCellsTruncateTableRowstruncate_cell()
- unitxt.system_prompts module
- unitxt.task module
- unitxt.templates module
DialogFieldsDataDialogPairwiseChoiceTemplateDialogTemplateInputOutputTemplateInputOutputTemplateWithCustomTargetKeyValTemplateMultiLabelTemplateMultiReferenceTemplateMultipleChoiceTemplateOutputQuantizingTemplatePairwiseChoiceTemplatePairwiseComparativeRatingTemplateSpanLabelingBaseTemplateSpanLabelingJsonTemplateSpanLabelingTemplateTemplateTemplateFormatKeyErrorTemplatesDictTemplatesListYesNoTemplateescape_chars()random()
- unitxt.text_utils module
- unitxt.type_utils module
NormalizedTypeUnsupportedTypeErrorconvert_union_type()eval_forward_ref()format_type_string()get_args()get_origin()infer_type()infer_type_string()is_type()is_type_dict()isoftype()issubtype()normalize()optional_all()optional_any()parse_type_dict()parse_type_string()to_float_or_default()to_type_dict()to_type_string()verify_required_schema()
- unitxt.utils module
- unitxt.validate module
- unitxt.version module