Hide navigation sidebar

Hide table of contents sidebar

🚧 vak version 1.0.0 is in development! 🚧 📣 Test out the alpha release: pip install vak==1.0.0a3. 📣 For more info, please see this forum post .

Toggle site navigation sidebar

vak documentation

Toggle table of contents sidebar

Getting Started
Toggle navigation of Getting Started
- Installation
- Automated Annotation
How-to guides
Toggle navigation of How-to guides
Frequently Asked Questions (FAQs)
Reference
Toggle navigation of Reference
Development
Toggle navigation of Development
- Contributors Guide
API Reference
Toggle navigation of API Reference
- vak.cli.cli
  Toggle navigation of vak.cli.cli
- vak.cli.eval
  Toggle navigation of vak.cli.eval
  - vak.cli.eval.eval
- vak.cli.learncurve
  Toggle navigation of vak.cli.learncurve
  - vak.cli.learncurve.learning_curve
- vak.cli.predict
  Toggle navigation of vak.cli.predict
  - vak.cli.predict.predict
- vak.cli.prep
  Toggle navigation of vak.cli.prep
  - vak.cli.prep.prep
  - vak.cli.prep.purpose_from_toml
- vak.cli.train
  Toggle navigation of vak.cli.train
  - vak.cli.train.train
- vak.prep
  Toggle navigation of vak.prep
  - vak.prep.audio_dataset
    Toggle navigation of vak.prep.audio_dataset
    - vak.prep.audio_dataset.prep_audio_dataset
  - vak.prep.constants
  - vak.prep.dataset_df_helper
    Toggle navigation of vak.prep.dataset_df_helper
  - vak.prep.frame_classification
    Toggle navigation of vak.prep.frame_classification
    - vak.prep.frame_classification.assign_samples_to_splits
    - vak.prep.frame_classification.frame_classification
      Toggle navigation of vak.prep.frame_classification.frame_classification
      - vak.prep.frame_classification.frame_classification.prep_frame_classification_dataset
    - vak.prep.frame_classification.learncurve
      Toggle navigation of vak.prep.frame_classification.learncurve
    - vak.prep.frame_classification.make_splits
      Toggle navigation of vak.prep.frame_classification.make_splits
    - vak.prep.frame_classification.source_files
      Toggle navigation of vak.prep.frame_classification.source_files
      - vak.prep.frame_classification.source_files.get_or_make_source_files
    - vak.prep.frame_classification.validators
      Toggle navigation of vak.prep.frame_classification.validators
      - vak.prep.frame_classification.validators.validate_and_get_frame_dur
  - vak.prep.parametric_umap
    Toggle navigation of vak.prep.parametric_umap
    - vak.prep.parametric_umap.dataset_arrays
      Toggle navigation of vak.prep.parametric_umap.dataset_arrays
      - vak.prep.parametric_umap.dataset_arrays.move_files_into_split_subdirs
    - vak.prep.parametric_umap.parametric_umap
      Toggle navigation of vak.prep.parametric_umap.parametric_umap
      - vak.prep.parametric_umap.parametric_umap.prep_parametric_umap_dataset
  - vak.prep.prep_
    Toggle navigation of vak.prep.prep_
    - vak.prep.prep_.prep
  - vak.prep.sequence_dataset
    Toggle navigation of vak.prep.sequence_dataset
    - vak.prep.sequence_dataset.has_unlabeled_segments
    - vak.prep.sequence_dataset.where_unlabeled_segments
  - vak.prep.spectrogram_dataset
    Toggle navigation of vak.prep.spectrogram_dataset
    - vak.prep.spectrogram_dataset.audio_helper
      Toggle navigation of vak.prep.spectrogram_dataset.audio_helper
      - vak.prep.spectrogram_dataset.audio_helper.files_from_dir
      - vak.prep.spectrogram_dataset.audio_helper.make_spectrogram_files_from_audio_files
    - vak.prep.spectrogram_dataset.prep
      Toggle navigation of vak.prep.spectrogram_dataset.prep
      - vak.prep.spectrogram_dataset.prep.prep_spectrogram_dataset
    - vak.prep.spectrogram_dataset.spect
      Toggle navigation of vak.prep.spectrogram_dataset.spect
    - vak.prep.spectrogram_dataset.spect_helper
      Toggle navigation of vak.prep.spectrogram_dataset.spect_helper
      - vak.prep.spectrogram_dataset.spect_helper.make_dataframe_of_spect_files
  - vak.prep.split
    Toggle navigation of vak.prep.split
    - vak.prep.split.algorithms
      Toggle navigation of vak.prep.split.algorithms
      - vak.prep.split.algorithms.bruteforce
        Toggle navigation of vak.prep.split.algorithms.bruteforce
        
        vak.prep.split.algorithms.bruteforce.brute_force
        
        vak.prep.split.algorithms.bruteforce.unique_set_from_labels
        
        vak.prep.split.algorithms.bruteforce.validate_labels
      - vak.prep.split.algorithms.validate
        Toggle navigation of vak.prep.split.algorithms.validate
        
        vak.prep.split.algorithms.validate.validate_split_durations
    - vak.prep.split.split
      Toggle navigation of vak.prep.split.split
  - vak.prep.unit_dataset
    Toggle navigation of vak.prep.unit_dataset
    - vak.prep.unit_dataset.unit_dataset
      Toggle navigation of vak.prep.unit_dataset.unit_dataset
- vak.prep.frame_classification
  Toggle navigation of vak.prep.frame_classification
  - vak.prep.frame_classification.assign_samples_to_splits
  - vak.prep.frame_classification.frame_classification
    Toggle navigation of vak.prep.frame_classification.frame_classification
    - vak.prep.frame_classification.frame_classification.prep_frame_classification_dataset
  - vak.prep.frame_classification.learncurve
    Toggle navigation of vak.prep.frame_classification.learncurve
  - vak.prep.frame_classification.make_splits
    Toggle navigation of vak.prep.frame_classification.make_splits
  - vak.prep.frame_classification.source_files
    Toggle navigation of vak.prep.frame_classification.source_files
    - vak.prep.frame_classification.source_files.get_or_make_source_files
  - vak.prep.frame_classification.validators
    Toggle navigation of vak.prep.frame_classification.validators
    - vak.prep.frame_classification.validators.validate_and_get_frame_dur
- vak.prep.parametric_umap
  Toggle navigation of vak.prep.parametric_umap
  - vak.prep.parametric_umap.dataset_arrays
    Toggle navigation of vak.prep.parametric_umap.dataset_arrays
    - vak.prep.parametric_umap.dataset_arrays.move_files_into_split_subdirs
  - vak.prep.parametric_umap.parametric_umap
    Toggle navigation of vak.prep.parametric_umap.parametric_umap
    - vak.prep.parametric_umap.parametric_umap.prep_parametric_umap_dataset
- vak.prep.spectrogram_dataset
  Toggle navigation of vak.prep.spectrogram_dataset
  - vak.prep.spectrogram_dataset.audio_helper
    Toggle navigation of vak.prep.spectrogram_dataset.audio_helper
    - vak.prep.spectrogram_dataset.audio_helper.files_from_dir
    - vak.prep.spectrogram_dataset.audio_helper.make_spectrogram_files_from_audio_files
  - vak.prep.spectrogram_dataset.prep
    Toggle navigation of vak.prep.spectrogram_dataset.prep
    - vak.prep.spectrogram_dataset.prep.prep_spectrogram_dataset
  - vak.prep.spectrogram_dataset.spect
    Toggle navigation of vak.prep.spectrogram_dataset.spect
  - vak.prep.spectrogram_dataset.spect_helper
    Toggle navigation of vak.prep.spectrogram_dataset.spect_helper
    - vak.prep.spectrogram_dataset.spect_helper.make_dataframe_of_spect_files
- vak.prep.unit_dataset
  Toggle navigation of vak.prep.unit_dataset
  - vak.prep.unit_dataset.unit_dataset
    Toggle navigation of vak.prep.unit_dataset.unit_dataset
- vak.prep.audio_dataset
  Toggle navigation of vak.prep.audio_dataset
  - vak.prep.audio_dataset.prep_audio_dataset
- vak.prep.constants
- vak.prep.dataset_df_helper
  Toggle navigation of vak.prep.dataset_df_helper
- vak.prep.prep_
  Toggle navigation of vak.prep.prep_
  - vak.prep.prep_.prep
- vak.prep.sequence_dataset
  Toggle navigation of vak.prep.sequence_dataset
  - vak.prep.sequence_dataset.has_unlabeled_segments
  - vak.prep.sequence_dataset.where_unlabeled_segments
- vak.prep.split.algorithms.bruteforce
  Toggle navigation of vak.prep.split.algorithms.bruteforce
- vak.prep.split.algorithms.validate
  Toggle navigation of vak.prep.split.algorithms.validate
  - vak.prep.split.algorithms.validate.validate_split_durations
- vak.prep.split.split
  Toggle navigation of vak.prep.split.split
- vak.train.train_
  Toggle navigation of vak.train.train_
  - vak.train.train_.train
- vak.train.frame_classification
  Toggle navigation of vak.train.frame_classification
  - vak.train.frame_classification.get_split_dur
  - vak.train.frame_classification.train_frame_classification_model
- vak.train.parametric_umap
  Toggle navigation of vak.train.parametric_umap
- vak.eval.eval_
  Toggle navigation of vak.eval.eval_
  - vak.eval.eval_.eval
- vak.eval.frame_classification
  Toggle navigation of vak.eval.frame_classification
  - vak.eval.frame_classification.eval_frame_classification_model
- vak.eval.parametric_umap
  Toggle navigation of vak.eval.parametric_umap
  - vak.eval.parametric_umap.eval_parametric_umap_model
- vak.predict.predict_
  Toggle navigation of vak.predict.predict_
  - vak.predict.predict_.predict
- vak.predict.frame_classification
  Toggle navigation of vak.predict.frame_classification
  - vak.predict.frame_classification.predict_with_frame_classification_model
- vak.predict.parametric_umap
  Toggle navigation of vak.predict.parametric_umap
  - vak.predict.parametric_umap.predict_with_parametric_umap_model
- vak.learncurve.curvefit
  Toggle navigation of vak.learncurve.curvefit
  - vak.learncurve.curvefit.fit_learning_curve
  - vak.learncurve.curvefit.residual_two_functions
- vak.learncurve.dirname
  Toggle navigation of vak.learncurve.dirname
  - vak.learncurve.dirname.replicate_dirname
  - vak.learncurve.dirname.train_dur_dirname
- vak.learncurve.frame_classification
  Toggle navigation of vak.learncurve.frame_classification
  - vak.learncurve.frame_classification.learning_curve_for_frame_classification_model
- vak.learncurve.learncurve
  Toggle navigation of vak.learncurve.learncurve
  - vak.learncurve.learncurve.learning_curve
- vak.config.config
  Toggle navigation of vak.config.config
  - vak.config.config.Config
- vak.config.eval
  Toggle navigation of vak.config.eval
- vak.config.learncurve
  Toggle navigation of vak.config.learncurve
  - vak.config.learncurve.LearncurveConfig
- vak.config.model
  Toggle navigation of vak.config.model
  - vak.config.model.config_from_toml_dict
  - vak.config.model.config_from_toml_path
- vak.config.parse
  Toggle navigation of vak.config.parse
- vak.config.predict
  Toggle navigation of vak.config.predict
  - vak.config.predict.PredictConfig
- vak.config.prep
  Toggle navigation of vak.config.prep
- vak.config.spect_params
  Toggle navigation of vak.config.spect_params
- vak.config.train
  Toggle navigation of vak.config.train
  - vak.config.train.TrainConfig
- vak.config.validators
  Toggle navigation of vak.config.validators
- vak.datasets.frame_classification
  Toggle navigation of vak.datasets.frame_classification
  - vak.datasets.frame_classification.constants
  - vak.datasets.frame_classification.frames_dataset
    Toggle navigation of vak.datasets.frame_classification.frames_dataset
    - vak.datasets.frame_classification.frames_dataset.FramesDataset
  - vak.datasets.frame_classification.helper
    Toggle navigation of vak.datasets.frame_classification.helper
  - vak.datasets.frame_classification.metadata
    Toggle navigation of vak.datasets.frame_classification.metadata
  - vak.datasets.frame_classification.window_dataset
    Toggle navigation of vak.datasets.frame_classification.window_dataset
    - vak.datasets.frame_classification.window_dataset.get_window_inds
    - vak.datasets.frame_classification.window_dataset.WindowDataset
- vak.datasets.parametric_umap
  Toggle navigation of vak.datasets.parametric_umap
  - vak.datasets.parametric_umap.metadata
    Toggle navigation of vak.datasets.parametric_umap.metadata
  - vak.datasets.parametric_umap.parametric_umap
    Toggle navigation of vak.datasets.parametric_umap.parametric_umap
- vak.metrics.classification.classification
  Toggle navigation of vak.metrics.classification.classification
  - vak.metrics.classification.classification.Accuracy
- vak.metrics.classification.functional
  Toggle navigation of vak.metrics.classification.functional
  - vak.metrics.classification.functional.accuracy
- vak.metrics.distance.distance
  Toggle navigation of vak.metrics.distance.distance
  - vak.metrics.distance.distance.CharacterErrorRate
  - vak.metrics.distance.distance.Levenshtein
- vak.metrics.distance.functional
  Toggle navigation of vak.metrics.distance.functional
  - vak.metrics.distance.functional.character_error_rate
  - vak.metrics.distance.functional.levenshtein
- vak.models.base
  Toggle navigation of vak.models.base
  - vak.models.base.Model
- vak.models.convencoder_umap
  Toggle navigation of vak.models.convencoder_umap
  - vak.models.convencoder_umap.ConvEncoderUMAP
- vak.models.decorator
  Toggle navigation of vak.models.decorator
  - vak.models.decorator.model
  - vak.models.decorator.ModelDefinitionValidationError
- vak.models.definition
  Toggle navigation of vak.models.definition
  - vak.models.definition.validate
  - vak.models.definition.ModelDefinition
- vak.models.ed_tcn
  Toggle navigation of vak.models.ed_tcn
  - vak.models.ed_tcn.ED_TCN
- vak.models.frame_classification_model
  Toggle navigation of vak.models.frame_classification_model
  - vak.models.frame_classification_model.FrameClassificationModel
- vak.models.get
- vak.models.parametric_umap_model
  Toggle navigation of vak.models.parametric_umap_model
- vak.models.registry
  Toggle navigation of vak.models.registry
  - vak.models.registry.model_family
  - vak.models.registry.register_model
- vak.models.tweetynet
  Toggle navigation of vak.models.tweetynet
  - vak.models.tweetynet.TweetyNet
- vak.nets.conv_encoder
  Toggle navigation of vak.nets.conv_encoder
  - vak.nets.conv_encoder.ConvEncoder
- vak.nets.ed_tcn
  Toggle navigation of vak.nets.ed_tcn
  - vak.nets.ed_tcn.ED_TCN
- vak.nets.tweetynet
  Toggle navigation of vak.nets.tweetynet
  - vak.nets.tweetynet.TweetyNet
- vak.nn.loss
  Toggle navigation of vak.nn.loss
  - vak.nn.loss.dice
    Toggle navigation of vak.nn.loss.dice
    - vak.nn.loss.dice.dice_loss
    - vak.nn.loss.dice.DiceLoss
  - vak.nn.loss.umap
    Toggle navigation of vak.nn.loss.umap
- vak.nn.functional
  Toggle navigation of vak.nn.functional
  - vak.nn.functional.one_hot
- vak.plot.annot
  Toggle navigation of vak.plot.annot
- vak.plot.learncurve
  Toggle navigation of vak.plot.learncurve
- vak.plot.spect
- vak.transforms.defaults
  Toggle navigation of vak.transforms.defaults
  - vak.transforms.defaults.frame_classification
    Toggle navigation of vak.transforms.defaults.frame_classification
  - vak.transforms.defaults.get
    Toggle navigation of vak.transforms.defaults.get
    - vak.transforms.defaults.get.get_default_transform
  - vak.transforms.defaults.parametric_umap
    Toggle navigation of vak.transforms.defaults.parametric_umap
    - vak.transforms.defaults.parametric_umap.get_default_parametric_umap_transform
- vak.transforms.frame_labels.functional
  Toggle navigation of vak.transforms.frame_labels.functional
- vak.transforms.frame_labels.transforms
  Toggle navigation of vak.transforms.frame_labels.transforms
- vak.transforms.functional
  Toggle navigation of vak.transforms.functional
- vak.transforms.transforms
  Toggle navigation of vak.transforms.transforms
- vak.common.annotation
  Toggle navigation of vak.common.annotation
- vak.common.constants
- vak.common.converters
  Toggle navigation of vak.common.converters
- vak.common.device
  Toggle navigation of vak.common.device
  - vak.common.device.get_default
- vak.common.files
  Toggle navigation of vak.common.files
  - vak.common.files.files
    Toggle navigation of vak.common.files.files
    - vak.common.files.files.find_fname
    - vak.common.files.files.from_dir
  - vak.common.files.spect
    Toggle navigation of vak.common.files.spect
- vak.common.labels
  Toggle navigation of vak.common.labels
- vak.common.learncurve
  Toggle navigation of vak.common.learncurve
  - vak.common.learncurve.get_train_dur_replicate_subset_name
- vak.common.logging
  Toggle navigation of vak.common.logging
  - vak.common.logging.config_logging_for_cli
  - vak.common.logging.log_version
- vak.common.paths
  Toggle navigation of vak.common.paths
  - vak.common.paths.generate_results_dir_name_as_path
- vak.common.tensorboard
  Toggle navigation of vak.common.tensorboard
  - vak.common.tensorboard.events2df
  - vak.common.tensorboard.get_summary_writer
- vak.common.timebins
  Toggle navigation of vak.common.timebins
  - vak.common.timebins.timebin_dur_from_vec
- vak.common.timenow
  Toggle navigation of vak.common.timenow
  - vak.common.timenow.get_timenow_as_str
- vak.common.trainer
  Toggle navigation of vak.common.trainer
  - vak.common.trainer.get_default_train_callbacks
  - vak.common.trainer.get_default_trainer
- vak.common.typing
- vak.common.validators
  Toggle navigation of vak.common.validators
About vak
Poems
Toggle navigation of Poems

v: latest

Versions: latest; stable

Downloads

On Read the Docs: Project Home; Builds

Toggle table of contents sidebar

vak.common.typing#

vak.common.validators

vak.common.trainer.get_default_trainer

Copyright © 2017-present, David Nicholson, Yarden Cohen

Made with Sphinx and @pradyunsg's Furo