Welcome to animal-soup’s documentation!

Contents:

• Background
  • Flow Generator
  • Feature Extractor
  • Sequence Model
• Installation
• User Guide
• Accessors and Extensions
• Data Management
• Inference
• Visualization
• Customization/Extension
  • Using Your Own Model Checkpoints - Training
  • Using Your Own Model Checkpoints - Inference
• API
  • Behavior
  • Flow Generator
  • Feature Extractor
  • Sequence Model
  • Utility Functions
  • Visualization

Summary

animal-soup is an automated behavioral classification software that allows members of the Hantman Lab to quickly and efficiently generate ethograms for their reach-to-grab behavioral data. It is a collection of “pandas extensions”, which are functions that operate on pandas DataFrames and Series. animal-soup essentially creates a user-friendly “psuedo-database” of your behavioral data, interfacing with with fastplotlib for fast visualization and editing of predicted behavioral labels. Behavioral classification training and inference has been adopted from DeepEthogram.

Indices and tables

• Index

• Module Index

• Search Page