Code Documentation¶
unitxt package¶
Subpackages¶
- unitxt.prepare_utils package
- unitxt.service package
- unitxt.test_utils package
- unitxt.ui package
Submodules¶
- unitxt.api module
- unitxt.artifact module
Artifact
Artifact.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.register_class()
Artifact.save()
Artifact.verify()
Artifact.verify_artifact_dict()
Artifact.verify_data_classification_policy()
Artifact.verify_instance()
ArtifactList
Artifactories
Artifactory
MissingArtifactTypeError
UnitxtArtifactNotFoundError
UnrecognizedArtifactTypeError
fetch_artifact()
get_artifactory_name_and_args()
get_artifacts_data_classification()
get_closest_artifact_type()
get_raw()
map_values_in_place()
maybe_recover_artifact()
register_all_artifacts()
reset_artifacts_json_cache()
verbosed_fetch_artifact()
- unitxt.blocks module
- unitxt.card module
- unitxt.catalog module
- unitxt.collections module
- unitxt.collections_operators module
- unitxt.dataclass module
AbstractField
AbstractFieldError
Dataclass
DataclassMeta
DeprecatedField
Field
FinalField
FinalFieldError
InternalField
MissingDefaultError
NonPositionalField
OptionalField
RequiredField
RequiredFieldError
TypeMismatchError
Undefined
UnexpectedArgumentError
abstract_fields()
asdict()
class_fields()
deprecated_fields()
fields()
fields_names()
final_fields()
get_field_default()
get_fields()
is_abstract_field()
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
Accuracy
BertScore
BinaryAccuracy
BinaryMaxAccuracy
BinaryMaxF1
BulkInstanceMetric
CharEditDistance
CharEditDistanceAccuracy
CustomF1
CustomF1Fuzzy
Detector
F1
F1Binary
F1BinaryPosOnly
F1Macro
F1MacroMultiLabel
F1Micro
F1MicroMultiLabel
F1MultiLabel
F1Weighted
FixedGroupAbsvalNormCohensHParaphraseAccuracy
FixedGroupAbsvalNormCohensHParaphraseStringContainment
FixedGroupAbsvalNormHedgesGParaphraseAccuracy
FixedGroupAbsvalNormHedgesGParaphraseStringContainment
FixedGroupMeanAccuracy
FixedGroupMeanBaselineAccuracy
FixedGroupMeanBaselineStringContainment
FixedGroupMeanParaphraseAccuracy
FixedGroupMeanParaphraseStringContainment
FixedGroupMeanStringContainment
FixedGroupNormCohensHParaphraseAccuracy
FixedGroupNormCohensHParaphraseStringContainment
FixedGroupNormHedgesGParaphraseAccuracy
FixedGroupNormHedgesGParaphraseStringContainment
FixedGroupPDRParaphraseAccuracy
FixedGroupPDRParaphraseStringContainment
FuzzyNer
GlobalMetric
GroupMeanAccuracy
GroupMeanStringContainment
GroupMeanTokenOverlap
HuggingfaceBulkMetric
HuggingfaceMetric
InstanceMetric
JaccardIndex
KPA
KendallTauMetric
LlamaIndexCorrectness
MAP
MRR
MatthewsCorrelation
MaxAccuracy
Metric
MetricPipeline
MetricWithConfidenceInterval
NDCG
NER
NormalizedSacrebleu
Perplexity
PrecisionBinary
PrecisionMacroMultiLabel
PrecisionMicroMultiLabel
RecallBinary
RecallMacroMultiLabel
RecallMicroMultiLabel
RemoteMetric
RerankRecall
RetrievalAtK
RetrievalMetric
Reward
RocAuc
Rouge
SentenceBert
Spearmanr
Squad
StringContainment
TokenOverlap
UnsortedListExactMatch
UpdateStream
Wer
abstract_factory()
abstract_field()
interpret_effect_size()
mean_subgroup_score()
nan_max()
nan_mean()
normalize_answer()
normalized_cohens_h()
normalized_hedges_g()
performance_drop_rate()
pytrec_eval_at_k()
validate_subgroup_types()
- unitxt.normalizers module
- unitxt.operator module
BaseFieldOperator
InstanceOperator
InstanceOperatorValidator
InstanceOperatorWithMultiStreamAccess
MissingRequirementsError
MultiStreamOperator
Operator
OperatorError
PackageRequirementsMixin
PagedStreamOperator
SequentialOperator
SequentialOperatorInitializer
SideEffectOperator
SingleStreamOperator
SingleStreamReducer
SourceOperator
SourceSequentialOperator
StreamInitializerOperator
StreamOperator
StreamingOperator
instance_generator()
stream_single()
- unitxt.operators module
- Operators: Building Blocks of Unitxt Processing Pipelines
AddConstant
AddFields
AddID
Apply
ApplyMetric
ApplyOperatorsField
ApplyStreamOperatorsField
ArtifactFetcherMixin
AugmentPrefixSuffix
AugmentWhitespace
Augmentor
CastFields
ComputeExpressionMixin
CopyFields
DeterministicBalancer
DivideAllFieldsBy
DownloadError
DownloadOperator
DuplicateInstances
EncodeLabels
ExecuteExpression
ExtractFieldValues
ExtractMostCommonFieldValues
ExtractZipFile
FeatureGroupedShuffle
FieldOperator
FilterByCondition
FilterByExpression
FlattenInstances
FromIterables
GetItemByIndex
IndexOf
InstanceFieldOperator
InterleaveListsToDialogOperator
Intersect
IterableSource
JoinStr
LengthBalancer
ListFieldValues
MapInstanceValues
MergeStreams
MinimumOneExamplePerLabelRefiner
NullAugmentor
Perturb
RemoveFields
RemoveValues
RenameFields
Shuffle
ShuffleFieldValues
SplitByNestedGroup
SplitByValue
StreamRefiner
TakeByField
UnexpectedHttpCodeError
Unique
ZipFieldValues
- unitxt.parsing_utils module
- unitxt.processors module
Capitalize
ConvertToBoolean
DictOfListsToPairs
ExtractMtBenchLabelJudgment
ExtractMtBenchRatingJudgment
ExtractWithRegex
FirstCharacter
GetStringAfter
ListToEmptyEntitiesTuples
LiteralEval
LowerCase
LowerCaseTillPunc
MatchClosestOption
RegexParser
SplitStrip
StanceToProCon
StrToFloatFormat
StringOrNotString
Substring
TakeFirstNonEmptyLine
TakeFirstWord
ToListByComma
ToString
ToStringStripped
ToYesOrNone
YesNoToInt
YesToOneElseZero
process_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
AddDemosField
BaseRecipe
CreateDemosPool
StandardRecipe
StandardRecipe.card
StandardRecipe.template
StandardRecipe.system_prompt
StandardRecipe.loader_limit
StandardRecipe.format
StandardRecipe.metrics
StandardRecipe.postprocessors
StandardRecipe.train_refiner
StandardRecipe.max_train_instances
StandardRecipe.validation_refiner
StandardRecipe.max_validation_instances
StandardRecipe.test_refiner
StandardRecipe.max_test_instances
StandardRecipe.demos_pool_size
StandardRecipe.num_demos
StandardRecipe.demos_pool_name
StandardRecipe.demos_taken_from
StandardRecipe.demos_field
StandardRecipe.demos_removed_from_data
StandardRecipe.sampler
StandardRecipe.steps
StandardRecipe.augmentor
StandardRecipe.instruction_card_index
StandardRecipe.template_card_index
StandardRecipe.prepare()
StandardRecipeWithIndexes
- unitxt.stream module
- unitxt.string_operators module
- unitxt.struct_data_operators module
ConvertTableColNamesToSequential
DumpJson
ListToKeyValPairs
LoadJson
SerializeKeyValPairs
SerializeTable
SerializeTableAsDFLoader
SerializeTableAsIndexedRowMajor
SerializeTableAsJson
SerializeTableAsMarkdown
SerializeTableRowAsList
SerializeTableRowAsText
SerializeTriples
ShuffleTableColumns
ShuffleTableRows
TruncateTableCells
TruncateTableRows
truncate_cell()
- unitxt.system_prompts module
- unitxt.task module
- unitxt.templates module
DialogFieldsData
DialogPairwiseChoiceTemplate
DialogTemplate
InputOutputTemplate
InputOutputTemplateWithCustomTarget
KeyValTemplate
MultiLabelTemplate
MultiReferenceTemplate
MultipleChoiceTemplate
OutputQuantizingTemplate
PairwiseChoiceTemplate
SpanLabelingBaseTemplate
SpanLabelingJsonTemplate
SpanLabelingTemplate
Template
TemplateFormatKeyError
TemplatesDict
TemplatesList
YesNoTemplate
escape_chars()
random()
- unitxt.text_utils module
- unitxt.type_utils module
- unitxt.utils module
- unitxt.validate module
- unitxt.version module