modalities

• modalities package
  • Subpackages
    • modalities.checkpointing package
      • Subpackages
      • Submodules
      • modalities.checkpointing.checkpoint_conversion module
      • modalities.checkpointing.checkpoint_loading module
      • modalities.checkpointing.checkpoint_saving module
      • modalities.checkpointing.checkpoint_saving_execution module
      • modalities.checkpointing.checkpoint_saving_instruction module
      • modalities.checkpointing.checkpoint_saving_strategies module
      • Module contents
    • modalities.config package
      • Submodules
      • modalities.config.component_factory module
      • modalities.config.config module
      • modalities.config.instantiation_models module
      • modalities.config.lookup_enum module
      • modalities.config.pydantic_if_types module
      • modalities.config.utils module
      • Module contents
    • modalities.conversion package
      • Subpackages
      • Module contents
    • modalities.dataloader package
      • Subpackages
      • Submodules
      • modalities.dataloader.apply_chat_template module
      • modalities.dataloader.create_index module
      • modalities.dataloader.create_instruction_tuning_data module
      • modalities.dataloader.create_packed_data module
      • modalities.dataloader.dataloader module
      • modalities.dataloader.dataloader_factory module
      • modalities.dataloader.dataset module
      • modalities.dataloader.dataset_factory module
      • modalities.dataloader.filter_packed_data module
      • modalities.dataloader.large_file_lines_reader module
      • modalities.dataloader.sampler_factory module
      • modalities.dataloader.samplers module
      • Module contents
    • modalities.inference package
      • Subpackages
      • Submodules
      • modalities.inference.inference module
      • Module contents
    • modalities.logging_broker package
      • Subpackages
      • Submodules
      • modalities.logging_broker.message_broker module
      • modalities.logging_broker.messages module
      • modalities.logging_broker.publisher module
      • modalities.logging_broker.subscriber module
      • Module contents
    • modalities.models package
      • Subpackages
      • Submodules
      • modalities.models.model module
      • modalities.models.model_factory module
      • modalities.models.utils module
      • Module contents
    • modalities.nn package
      • Subpackages
      • Submodules
      • modalities.nn.attention module
      • modalities.nn.mlp module
      • Module contents
    • modalities.optimizers package
      • Submodules
      • modalities.optimizers.lr_schedulers module
      • modalities.optimizers.optimizer_factory module
      • Module contents
    • modalities.preprocessing package
      • Submodules
      • modalities.preprocessing.create_chunks module
      • modalities.preprocessing.shuffle_data module
      • Module contents
    • modalities.registry package
      • Submodules
      • modalities.registry.components module
      • modalities.registry.registry module
      • Module contents
    • modalities.running_env package
      • Subpackages
      • Submodules
      • modalities.running_env.cuda_env module
      • modalities.running_env.env_utils module
      • Module contents
    • modalities.tokenization package
      • Submodules
      • modalities.tokenization.tokenizer_wrapper module
      • Module contents
    • modalities.training package
      • Subpackages
      • Submodules
      • modalities.training.training_progress module
      • Module contents
    • modalities.utils package
      • Subpackages
      • Submodules
      • modalities.utils.communication_test module
      • modalities.utils.debug module
      • modalities.utils.debug_components module
      • modalities.utils.debugging_configs module
      • modalities.utils.file_ops module
      • modalities.utils.logger_utils module
      • modalities.utils.mfu module
      • modalities.utils.number_conversion module
      • modalities.utils.seeding module
      • modalities.utils.typing_utils module
      • modalities.utils.verify_tokenization_consistency module
      • Module contents
  • Submodules
  • modalities.api module
    • FileExistencePolicy
      • FileExistencePolicy.ERROR
      • FileExistencePolicy.OVERRIDE
      • FileExistencePolicy.SKIP
    • convert_pytorch_to_hf_checkpoint()
    • create_filtered_tokenized_dataset()
    • create_raw_data_index()
    • create_shuffled_dataset_chunk()
    • create_shuffled_jsonl_dataset_chunk()
    • enforce_file_existence_policy()
    • generate_text()
    • merge_packed_data_files()
    • pack_encoded_data()
    • shuffle_jsonl_data()
    • shuffle_tokenized_data()
  • modalities.batch module
    • Batch
    • DatasetBatch
      • DatasetBatch.batch_dim
      • DatasetBatch.detach()
      • DatasetBatch.device
      • DatasetBatch.samples
      • DatasetBatch.targets
      • DatasetBatch.to()
    • EvaluationResultBatch
      • EvaluationResultBatch.dataloader_tag
      • EvaluationResultBatch.losses
      • EvaluationResultBatch.metrics
      • EvaluationResultBatch.num_train_steps_done
      • EvaluationResultBatch.throughput_metrics
    • InferenceResultBatch
      • InferenceResultBatch.batch_dim
      • InferenceResultBatch.detach()
      • InferenceResultBatch.device
      • InferenceResultBatch.get_predictions()
      • InferenceResultBatch.get_targets()
      • InferenceResultBatch.predictions
      • InferenceResultBatch.targets
      • InferenceResultBatch.to()
      • InferenceResultBatch.to_cpu()
    • ResultItem
      • ResultItem.decimal_places
      • ResultItem.value
    • TorchDeviceMixin
      • TorchDeviceMixin.detach()
      • TorchDeviceMixin.device
      • TorchDeviceMixin.to()
  • modalities.evaluator module
    • Evaluator
      • Evaluator.evaluate()
      • Evaluator.evaluate_batch()
  • modalities.exceptions module
    • BatchStateError
    • CheckpointingError
    • ConfigError
    • DatasetNotFoundError
    • ModelStateError
    • OptimizerError
    • RunningEnvError
    • TimeRecorderStateError
  • modalities.gym module
    • Gym
      • Gym.run()
  • modalities.loss_functions module
    • CLMCrossEntropyLoss
    • Loss
      • Loss.tag
    • NCELoss
    • nce_loss()
  • modalities.main module
    • Main
      • Main.add_custom_component()
      • Main.build_components()
      • Main.get_logging_publishers()
      • Main.run()
  • modalities.trainer module
    • ThroughputAggregationKeys
      • ThroughputAggregationKeys.FORWARD_BACKWARD_TIME
      • ThroughputAggregationKeys.NUM_SAMPLES
    • Trainer
      • Trainer.train()
  • modalities.util module
    • Aggregator
      • Aggregator.add_value()
      • Aggregator.get_all_reduced_value()
      • Aggregator.remove_key()
      • Aggregator.remove_keys()
    • TimeRecorder
      • TimeRecorder.reset()
      • TimeRecorder.start()
      • TimeRecorder.stop()
    • TimeRecorderStates
      • TimeRecorderStates.RUNNING
      • TimeRecorderStates.STOPPED
    • format_metrics_to_gb()
    • get_experiment_id_from_config()
    • get_local_number_of_trainable_parameters()
    • get_module_class_from_name()
    • get_synced_experiment_id_of_run()
    • get_synced_string()
    • get_total_number_of_trainable_parameters()
    • parse_enum_by_name()
    • print_rank_0()
    • warn_rank_0()
  • Module contents