Contents:
Introduction
Loading Datasets
Installation
Adding Datasets
Adding Stream Operators and Metrics
Concepts
Backend
Operators
Contributors Guide
unitxt
Catalog
Unitxt
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
Y
|
Z
A
abstract (unitxt.dataclass.Field attribute)
abstract_factory() (in module unitxt.metrics)
abstract_field() (in module unitxt.metrics)
abstract_fields() (in module unitxt.dataclass)
AbstractField (class in unitxt.dataclass)
AbstractFieldError
Accuracy (class in unitxt.metrics)
activate() (unitxt.generator_utils.ReusableGenerator method)
add_classification_choices() (in module unitxt.prepare_utils.card_types)
add_to_catalog() (in module unitxt.catalog)
AddConstant (class in unitxt.operators)
AddDemosField (class in unitxt.standard)
AddFields (class in unitxt.operators)
AddID (class in unitxt.operators)
Apply (class in unitxt.operators)
apply_metric() (in module unitxt.test_utils.metrics)
apply_operator() (in module unitxt.test_utils.operators)
ApplyMetric (class in unitxt.operators)
ApplyOperatorsField (class in unitxt.operators)
ApplyStreamOperatorsField (class in unitxt.operators)
args (unitxt.type_utils.NormalizedType attribute)
Artifact (class in unitxt.artifact)
ArtifactFetcherMixin (class in unitxt.operators)
ArtifactList (class in unitxt.artifact)
Artifactories (class in unitxt.artifact)
Artifactory (class in unitxt.artifact)
asdict() (in module unitxt.dataclass)
augmentable_inputs (unitxt.task.FormTask attribute)
Augmentor (class in unitxt.operators)
augmentor (unitxt.standard.StandardRecipe attribute)
AugmentPrefixSuffix (class in unitxt.operators)
AugmentWhitespace (class in unitxt.operators)
B
BaseFieldOperator (class in unitxt.operator)
BaseFusion (class in unitxt.fusion)
BaseRecipe (class in unitxt.standard)
BertScore (class in unitxt.metrics)
build_stream_routing() (in module unitxt.split_utils)
BulkInstanceMetric (class in unitxt.metrics)
C
cache (unitxt.operators.ArtifactFetcherMixin attribute)
caching (unitxt.stream.Stream attribute)
camel_to_snake_case() (in module unitxt.text_utils)
card (unitxt.standard.StandardRecipe attribute)
CastFields (class in unitxt.operators)
Catalog (class in unitxt.catalog)
CharEditDistanceAccuracy (class in unitxt.metrics)
check_operator() (in module unitxt.test_utils.operators)
check_operator_exception() (in module unitxt.test_utils.operators)
ci_scores (unitxt.metrics.BertScore attribute)
(unitxt.metrics.TokenOverlap attribute)
class_fields() (in module unitxt.dataclass)
classes_to_ignore (unitxt.metrics.F1MultiLabel attribute)
Collection (class in unitxt.collections)
condition_to_func (unitxt.operators.FilterByCondition attribute)
construct_dict_str() (in module unitxt.text_utils)
construct_recipe_output_message() (in module unitxt.test_utils.card)
ConvertToBoolean (class in unitxt.processors)
CopyFields (class in unitxt.operators)
CopyingReusableGenerator (class in unitxt.generator_utils)
create_2sentences_classification_card() (in module unitxt.prepare_utils.card_types)
create_sentence_classification_card() (in module unitxt.prepare_utils.card_types)
CreateDemosPool (class in unitxt.standard)
CustomF1 (class in unitxt.metrics)
D
data (unitxt.stream.MultiStream attribute)
Dataclass (class in unitxt.dataclass)
DataclassMeta (class in unitxt.dataclass)
Dataset (class in unitxt.dataset)
default (unitxt.dataclass.Field attribute)
default_factory (unitxt.dataclass.Field attribute)
demos_field (unitxt.standard.StandardRecipe attribute)
demos_pool_name (unitxt.standard.StandardRecipe attribute)
demos_pool_size (unitxt.standard.StandardRecipe attribute)
demos_taken_from (unitxt.standard.StandardRecipe attribute)
DeterministicBalancer (class in unitxt.operators)
dict_creator() (in module unitxt.dict_utils)
dict_delete() (in module unitxt.dict_utils)
dict_equal() (in module unitxt.test_utils.metrics)
dict_get() (in module unitxt.dict_utils)
dict_set() (in module unitxt.dict_utils)
DictCollection (class in unitxt.collections)
DictOfListsToPairs (class in unitxt.processors)
DiverseLabelsSampler (class in unitxt.splitters)
DivideAllFieldsBy (class in unitxt.operators)
dpath_get() (in module unitxt.dict_utils)
dpath_set() (in module unitxt.dict_utils)
dpath_set_multiple() (in module unitxt.dict_utils)
dpath_set_one() (in module unitxt.dict_utils)
E
EmptyInstruction (class in unitxt.instructions)
enable_explicit_format() (in module unitxt.logging_utils)
EncodeLabels (class in unitxt.operators)
EnvironmentLocalCatalog (class in unitxt.catalog)
escape_characters (unitxt.templates.SpanLabelingTemplate attribute)
escape_chars() (in module unitxt.templates)
eval_forward_ref() (in module unitxt.type_utils)
ExecuteQuery (class in unitxt.operators)
ExtractFieldValues (class in unitxt.operators)
ExtractMostCommonFieldValues (class in unitxt.operators)
F
F1 (class in unitxt.metrics)
F1Macro (class in unitxt.metrics)
F1MacroMultiLabel (class in unitxt.metrics)
F1Micro (class in unitxt.metrics)
F1MicroMultiLabel (class in unitxt.metrics)
F1MultiLabel (class in unitxt.metrics)
F1Weighted (class in unitxt.metrics)
fetch() (in module unitxt.dataset)
fetch_artifact() (in module unitxt.artifact)
Field (class in unitxt.dataclass)
FieldOperator (class in unitxt.operators)
fields (unitxt.operators.DeterministicBalancer attribute)
fields() (in module unitxt.dataclass)
fields_names() (in module unitxt.dataclass)
FilterByCondition (class in unitxt.operators)
FilterByQuery (class in unitxt.operators)
final (unitxt.dataclass.Field attribute)
final_fields() (in module unitxt.dataclass)
FinalField (class in unitxt.dataclass)
FinalFieldError
FirstCharacter (class in unitxt.processors)
FixedFusion (class in unitxt.fusion)
flatten_dict() (in module unitxt.utils)
FlattenInstances (class in unitxt.operators)
Format (class in unitxt.formats)
format (unitxt.standard.StandardRecipe attribute)
FormTask (class in unitxt.task)
from_dict() (unitxt.artifact.Artifact class method)
from_exception() (unitxt.operator.OperatorError class method)
from_generators() (unitxt.stream.MultiStream class method)
from_iterables() (unitxt.stream.MultiStream class method)
from_operator_error() (unitxt.operator.OperatorError class method)
FromIterables (class in unitxt.operators)
FromPredictionsAndOriginalData (class in unitxt.metric)
G
gen_kwargs (unitxt.stream.Stream attribute)
generator (unitxt.stream.Stream attribute)
generators (unitxt.dataset.Dataset property)
get_all_files_in_dir() (in module unitxt.file_utils)
get_args() (in module unitxt.type_utils)
get_artifact() (unitxt.operators.ArtifactFetcherMixin class method)
get_artifact_type() (unitxt.artifact.Artifact class method)
get_closest_artifact_type() (in module unitxt.artifact)
get_dataset_artifact() (in module unitxt.dataset)
get_default() (unitxt.dataclass.Field method)
get_directory_size() (in module unitxt.test_utils.storage)
get_field_default() (in module unitxt.dataclass)
get_fields() (in module unitxt.dataclass)
get_generator() (unitxt.stream.MultiStream method)
get_logger() (in module unitxt.logging_utils)
get_missing_imports() (in module unitxt.hf_utils)
get_origin() (in module unitxt.type_utils)
get_seed() (in module unitxt.random_utils)
GithubCatalog (class in unitxt.catalog)
GlobalMetric (class in unitxt.metrics)
H
hf_compute_args (unitxt.metrics.HuggingfaceBulkMetric attribute)
hf_metric_fields (unitxt.metrics.BertScore attribute)
HFCachingContextManager (class in unitxt.hf_utils)
HuggingfaceBulkMetric (class in unitxt.metrics)
HuggingfaceMetric (class in unitxt.metrics)
I
IndexOf (class in unitxt.operators)
InputOutputTemplate (class in unitxt.templates)
instance (unitxt.artifact.Artifactories attribute)
InstanceMetric (class in unitxt.metrics)
InstanceOperator (class in unitxt.operator)
InstanceOperatorWithMultiStreamAccess (class in unitxt.operator)
Instruction (class in unitxt.instructions)
instruction (unitxt.standard.StandardRecipe attribute)
instruction_card_index (unitxt.standard.StandardRecipe attribute)
InstructionsDict (class in unitxt.instructions)
InstructionsList (class in unitxt.instructions)
InternalField (class in unitxt.dataclass)
Intersect (class in unitxt.operators)
is_abstract_field() (in module unitxt.dataclass)
is_artifact_dict() (unitxt.artifact.Artifact class method)
is_artifact_file() (unitxt.artifact.Artifact class method)
is_camel_case() (in module unitxt.text_utils)
is_dataclass() (in module unitxt.dataclass)
is_final_field() (in module unitxt.dataclass)
is_possible_field() (in module unitxt.dataclass)
is_registered_class() (unitxt.artifact.Artifact class method)
is_registered_class_name() (unitxt.artifact.Artifact class method)
is_registered_type() (unitxt.artifact.Artifact class method)
is_snake_case() (in module unitxt.text_utils)
is_subpath() (in module unitxt.dict_utils)
isoftype() (in module unitxt.type_utils)
issubtype() (in module unitxt.type_utils)
ItemPicker (class in unitxt.collections)
IterableSource (class in unitxt.operators)
J
JoinStr (class in unitxt.operators)
K
KeyValTemplate (class in unitxt.templates)
KPA (class in unitxt.metrics)
L
LengthBalancer (class in unitxt.operators)
ListCollection (class in unitxt.collections)
ListFieldValues (class in unitxt.operators)
ListToEmptyEntitiesTuples (class in unitxt.processors)
load() (unitxt.artifact.Artifact class method)
load_dataset() (in module unitxt.load)
load_examples_from_standard_recipe() (in module unitxt.test_utils.card)
load_json() (in module unitxt.utils)
LoadCSV (class in unitxt.loaders)
Loader (class in unitxt.loaders)
loader_limit (unitxt.standard.StandardRecipe attribute)
LoadFromIBMCloud (class in unitxt.loaders)
LoadFromKaggle (class in unitxt.loaders)
LoadHF (class in unitxt.loaders)
LoadJson (class in unitxt.processors)
LocalCatalog (class in unitxt.catalog)
LowerCase (class in unitxt.processors)
LowerCaseTillPunc (class in unitxt.processors)
M
main_score (unitxt.metrics.Metric property)
MAP (class in unitxt.metrics)
map_values_in_place() (in module unitxt.artifact)
MapInstanceValues (class in unitxt.operators)
mappers (unitxt.operators.MapInstanceValues attribute)
MatthewsCorrelation (class in unitxt.metrics)
max_instances (unitxt.operators.DeterministicBalancer attribute)
max_test_instances (unitxt.standard.StandardRecipe attribute)
max_train_instances (unitxt.standard.StandardRecipe attribute)
max_validation_instances (unitxt.standard.StandardRecipe attribute)
maybe_recover_artifact() (in module unitxt.artifact)
MergeStreams (class in unitxt.operators)
Metric (class in unitxt.metric)
(class in unitxt.metrics)
MetricPipeline (class in unitxt.metrics)
MetricRecipe (class in unitxt.metric)
MetricWithConfidenceInterval (class in unitxt.metrics)
MissingArtifactTypeError
MissingKaggleCredentialsError
module
unitxt
unitxt.artifact
unitxt.blocks
unitxt.card
unitxt.catalog
unitxt.collections
unitxt.dataclass
unitxt.dataset
unitxt.dict_utils
unitxt.file_utils
unitxt.formats
unitxt.fusion
unitxt.generator_utils
unitxt.hf_utils
unitxt.instructions
unitxt.load
unitxt.loaders
unitxt.logging_utils
unitxt.metric
unitxt.metrics
unitxt.normalizers
unitxt.operator
unitxt.operators
unitxt.prepare_utils
unitxt.prepare_utils.card_types
unitxt.prepare_utils.instructions
unitxt.processors
unitxt.random_utils
unitxt.recipe
unitxt.register
unitxt.schema
unitxt.split_utils
unitxt.splitters
unitxt.standard
unitxt.stream
unitxt.task
unitxt.templates
unitxt.test_utils
unitxt.test_utils.artifact
unitxt.test_utils.card
unitxt.test_utils.catalog
unitxt.test_utils.metrics
unitxt.test_utils.operators
unitxt.test_utils.storage
unitxt.text_utils
unitxt.type_utils
unitxt.utils
unitxt.validate
unitxt.version
MRR (class in unitxt.metrics)
MultiLabelTemplate (class in unitxt.templates)
MultipleChoiceTask (class in unitxt.task)
MultipleChoiceTemplate (class in unitxt.templates)
MultiReferenceTemplate (class in unitxt.templates)
MultiStream (class in unitxt.stream)
MultiStreamOperator (class in unitxt.operator)
MultiStreamScoreMean (class in unitxt.metric)
N
name (unitxt.dataclass.Field attribute)
NDCG (class in unitxt.metrics)
NER (class in unitxt.metrics)
nested_tuple_to_string() (in module unitxt.text_utils)
new_random_generator() (in module unitxt.random_utils)
NonPositionalField (class in unitxt.dataclass)
normalize() (in module unitxt.type_utils)
normalize_answer() (in module unitxt.metrics)
NormalizedType (class in unitxt.type_utils)
NormalizeListFields (class in unitxt.normalizers)
NullAugmentor (class in unitxt.operators)
num_demos (unitxt.standard.StandardRecipe attribute)
O
Operator (class in unitxt.operator)
OperatorError
optional_all() (in module unitxt.type_utils)
optional_any() (in module unitxt.type_utils)
OptionalField (class in unitxt.dataclass)
origin (unitxt.type_utils.NormalizedType attribute)
origin_cls (unitxt.dataclass.Field attribute)
OutputQuantizingTemplate (class in unitxt.templates)
P
PagedStreamOperator (class in unitxt.operator)
parse() (in module unitxt.dataset)
parse_random_mix_string() (in module unitxt.split_utils)
parse_slices_string() (in module unitxt.split_utils)
peek() (unitxt.stream.Stream method)
postprocessors (unitxt.templates.MultiLabelTemplate attribute)
(unitxt.templates.SpanLabelingJsonTemplate attribute)
(unitxt.templates.SpanLabelingTemplate attribute)
PrecisionMacroMultiLabel (class in unitxt.metrics)
PrecisionMicroMultiLabel (class in unitxt.metrics)
prefixes (unitxt.operators.AugmentPrefixSuffix attribute)
prepare() (unitxt.artifact.Artifact method)
(unitxt.standard.StandardRecipe method)
print_dict() (in module unitxt.text_utils)
print_recipe_output() (in module unitxt.test_utils.card)
process_every_value (unitxt.operators.MapInstanceValues attribute)
ProjectArtifactRegisterer (class in unitxt.register)
R
random_generator (unitxt.splitters.Sampler attribute)
random_mix_generator() (in module unitxt.split_utils)
random_mix_streams() (in module unitxt.split_utils)
RandomPicker (class in unitxt.collections)
RandomSampler (class in unitxt.splitters)
RecallMacroMultiLabel (class in unitxt.metrics)
RecallMicroMultiLabel (class in unitxt.metrics)
Recipe (class in unitxt.recipe)
reduction_map (unitxt.metrics.Accuracy attribute)
(unitxt.metrics.BertScore attribute)
(unitxt.metrics.CharEditDistanceAccuracy attribute)
(unitxt.metrics.InstanceMetric property)
(unitxt.metrics.MAP attribute)
(unitxt.metrics.MRR attribute)
(unitxt.metrics.Reward attribute)
(unitxt.metrics.SentenceBert attribute)
(unitxt.metrics.StringContainment attribute)
(unitxt.metrics.TokenOverlap attribute)
RegexParser (class in unitxt.processors)
register() (unitxt.artifact.Artifactories method)
register_all_artifacts() (in module unitxt.artifact)
(in module unitxt.register)
register_class() (unitxt.artifact.Artifact class method)
register_local_catalog() (in module unitxt.register)
register_local_catalog_for_tests() (in module unitxt.test_utils.catalog)
RemoveFields (class in unitxt.operators)
RemoveValues (class in unitxt.operators)
rename_split() (in module unitxt.split_utils)
RenameFields (class in unitxt.operators)
RenameSplits (class in unitxt.splitters)
required (unitxt.dataclass.Field attribute)
required_fields() (in module unitxt.dataclass)
RequiredField (class in unitxt.dataclass)
RequiredFieldError
reset() (unitxt.artifact.Artifactories method)
RetrievalAtK (class in unitxt.metrics)
RetrievalMetric (class in unitxt.metrics)
ReusableGenerator (class in unitxt.generator_utils)
Reward (class in unitxt.metrics)
Rouge (class in unitxt.metrics)
rouge_types (unitxt.metrics.Rouge attribute)
round_floats() (in module unitxt.test_utils.metrics)
S
Sampler (class in unitxt.splitters)
sampler (unitxt.standard.StandardRecipe attribute)
save() (unitxt.artifact.Artifact method)
save_json() (in module unitxt.utils)
SentenceBert (class in unitxt.metrics)
SeparateSplit (class in unitxt.splitters)
SequentialOperator (class in unitxt.operator)
SequentialOperatorInitilizer (class in unitxt.operator)
SequentialRecipe (class in unitxt.recipe)
set_caching() (unitxt.stream.MultiStream method)
set_copying() (unitxt.stream.MultiStream method)
set_verbosity() (in module unitxt.logging_utils)
Shuffle (class in unitxt.operators)
ShuffleFieldValues (class in unitxt.operators)
SingleStreamOperator (class in unitxt.operator)
SingleStreamReducer (class in unitxt.operator)
Singleton (class in unitxt.utils)
slice_stream() (in module unitxt.split_utils)
slice_streams() (in module unitxt.split_utils)
SliceSplit (class in unitxt.splitters)
SourceOperator (class in unitxt.operator)
SourceSequentialOperator (class in unitxt.operator)
SpanLabelingBaseTemplate (class in unitxt.templates)
SpanLabelingJsonTemplate (class in unitxt.templates)
SpanLabelingTemplate (class in unitxt.templates)
split_words() (in module unitxt.text_utils)
SplitByValue (class in unitxt.operators)
SplitRandomMix (class in unitxt.splitters)
Splitter (class in unitxt.splitters)
SpreadSplit (class in unitxt.splitters)
Squad (class in unitxt.metrics)
StanceToProCon (class in unitxt.processors)
StandardRecipe (class in unitxt.standard)
StandardRecipeWithIndexes (class in unitxt.standard)
StandardSchema (class in unitxt.validate)
steps (unitxt.standard.StandardRecipe attribute)
Stream (class in unitxt.stream)
StreamingOperator (class in unitxt.operator)
StreamInitializerOperator (class in unitxt.operator)
StreamInstanceOperator (class in unitxt.operator)
StreamInstanceOperatorValidator (class in unitxt.operator)
StreamRefiner (class in unitxt.operators)
StreamSource (class in unitxt.operator)
strict (unitxt.operators.MapInstanceValues attribute)
StringContainment (class in unitxt.metrics)
StringOrNotString (class in unitxt.processors)
suffixes (unitxt.operators.AugmentPrefixSuffix attribute)
SystemFormat (class in unitxt.formats)
T
take() (unitxt.stream.Stream method)
TakeByField (class in unitxt.operators)
TakeFirstNonEmptyLine (class in unitxt.processors)
TakeFirstWord (class in unitxt.processors)
TaskCard (class in unitxt.card)
Tasker (class in unitxt.task)
Template (class in unitxt.templates)
template (unitxt.standard.StandardRecipe attribute)
template_card_index (unitxt.standard.StandardRecipe attribute)
TemplatesDict (class in unitxt.templates)
TemplatesList (class in unitxt.templates)
test_adding_to_catalog() (in module unitxt.test_utils.card)
test_artfifact_saving_and_loading() (in module unitxt.test_utils.artifact)
test_card() (in module unitxt.test_utils.card)
test_loading_from_catalog() (in module unitxt.test_utils.card)
test_metric() (in module unitxt.test_utils.metrics)
test_metrics_exist() (in module unitxt.test_utils.card)
test_refiner (unitxt.standard.StandardRecipe attribute)
test_with_eval() (in module unitxt.test_utils.card)
TextualInstruction (class in unitxt.instructions)
to_dataset() (unitxt.stream.MultiStream method)
to_dict() (unitxt.dataclass.Dataclass method)
to_iterable_dataset() (unitxt.stream.MultiStream method)
TokenOverlap (class in unitxt.metrics)
ToListByComma (class in unitxt.processors)
ToString (class in unitxt.processors)
ToStringStripped (class in unitxt.processors)
ToUnitxtGroup (class in unitxt.schema)
ToYesOrNone (class in unitxt.processors)
train_refiner (unitxt.standard.StandardRecipe attribute)
type (unitxt.dataclass.Field attribute)
TypeMismatchError
U
UnexpectedArgumentError
Unique (class in unitxt.operators)
unitxt
module
unitxt.artifact
module
unitxt.blocks
module
unitxt.card
module
unitxt.catalog
module
unitxt.collections
module
unitxt.dataclass
module
unitxt.dataset
module
unitxt.dict_utils
module
unitxt.file_utils
module
unitxt.formats
module
unitxt.fusion
module
unitxt.generator_utils
module
unitxt.hf_utils
module
unitxt.instructions
module
unitxt.load
module
unitxt.loaders
module
unitxt.logging_utils
module
unitxt.metric
module
unitxt.metrics
module
unitxt.normalizers
module
unitxt.operator
module
unitxt.operators
module
unitxt.prepare_utils
module
unitxt.prepare_utils.card_types
module
unitxt.prepare_utils.instructions
module
unitxt.processors
module
unitxt.random_utils
module
unitxt.recipe
module
unitxt.register
module
unitxt.schema
module
unitxt.split_utils
module
unitxt.splitters
module
unitxt.standard
module
unitxt.stream
module
unitxt.task
module
unitxt.templates
module
unitxt.test_utils
module
unitxt.test_utils.artifact
module
unitxt.test_utils.card
module
unitxt.test_utils.catalog
module
unitxt.test_utils.metrics
module
unitxt.test_utils.operators
module
unitxt.test_utils.storage
module
unitxt.text_utils
module
unitxt.type_utils
module
unitxt.utils
module
unitxt.validate
module
unitxt.version
module
UnitxtArtifactNotFoundError
UnrecognizedArtifactTypeError
unregister() (unitxt.artifact.Artifactories method)
UpdateStream (class in unitxt.metrics)
V
ValidateSchema (class in unitxt.validate)
ValidateStandartSchema (class in unitxt.validate)
validation_refiner (unitxt.standard.StandardRecipe attribute)
Validator (class in unitxt.validate)
verbosed_fetch_artifact() (in module unitxt.artifact)
verify() (unitxt.artifact.Artifact method)
(unitxt.instructions.InstructionsDict method)
(unitxt.templates.TemplatesDict method)
verify_artifact_dict() (unitxt.artifact.Artifact class method)
verify_legal_catalog_name() (in module unitxt.catalog)
VERSION (unitxt.dataset.Dataset attribute)
W
WeightedFusion (class in unitxt.fusion)
Wer (class in unitxt.metrics)
Y
YesNoTemplate (class in unitxt.templates)
YesNoToInt (class in unitxt.processors)
Z
ZipFieldValues (class in unitxt.operators)