API Reference#

animal-soup Extensions

• Behavior
  • BehaviorDataFrameExtension
    • BehaviorDataFrameExtension.view()
    • BehaviorDataFrameExtension.clean_ethograms()
    • BehaviorDataFrameExtension.manual_ethograms()
    • BehaviorDataFrameExtension.add_item()
    • BehaviorDataFrameExtension.remove_item()
    • BehaviorDataFrameExtension.save_to_disk()
  • BehaviorSeriesExtensions
    • BehaviorSeriesExtensions.infer()
• Flow Generator
  • FlowGeneratorDataframeExtension
    • FlowGeneratorDataframeExtension.train()
• Feature Extractor
  • DataFrame Extensions
    • FeatureExtractorDataframeExtension
      • FeatureExtractorDataframeExtension.train()
  • Series Extensions
    • FeatureExtractorSeriesExtensions
      • FeatureExtractorSeriesExtensions.infer()
• Sequence Model
  • DataFrame Extensions
    • SequenceModelDataframeExtension
      • SequenceModelDataframeExtension.train()
  • Series Extensions
    • SequenceModelSeriesExtensions
      • SequenceModelSeriesExtensions.infer()

Functions

• Utility Functions
  • create_df()
  • load_df()
  • set_parent_raw_data_path()
  • get_parent_raw_data_path()

Visualization

• Visualization
  • BehaviorVizContainer
  • EthogramVizContainer
  • EthogramCleanerVizContainer
  • EthogramComparisonVizContainer