Skip to main content

DLC2Action is a deep learning based action segmentation toolbox. It is designed to work directly on top of markerless pose estimation softwares such as DeepLabCut. It allows to train and evaluate various state-of-the-art action segmentation models on your own data.

Project description

Code style: black Version PyPI version Downloads Downloads Generic badge

logo

🌈 DLC2Action

DLC2Action is an action segmentation package that makes running and tracking experiments easy.

🛠️ Installation

You can simply install DLC2Action by typing:

pip install dlc2action

Or you can install the latest DLC2Action for development by running this in your terminal:

git clone https://github.com/amathislab/DLC2Action
cd DLC2Action
conda create --name DLC2Action python=3.13
conda activate DLC2Action
python -m pip install .

📖 Features

The functionality of DLC2Action includes:

  • a GUI for annotation, visualization and active learning
  • compiling and updating project-specific configuration files,
  • filling in the configuration dictionaries automatically whenever possible,
  • saving training parameters and results,
  • running predictions and hyperparameter searches,
  • creating active learning files,
  • loading hyperparameter search results in experiments and dumping them into configuration files,
  • comparing new experiment parameters with the project history and loading pre-computed features (to save time) and previously created splits (to enforce consistency) when there is a match,
  • filtering and displaying training, prediction and hyperparameter search history,
  • plotting training curve comparisons

and more.

⚡ A quick example

You can start a new project, run an experiment, visualize it and use the trained model to make a prediction in a few lines of code:

project = Project("project", data_type="dlc_track", annotation_type="csv")
project.update_parameters(...)
project.run_default_hyperparameter_search("search")
project.run_episode("episode", load_search="search")
project.evaluate(["episode"])
project.run_prediction("prediction", episode_names=["episode"], data_path="/path/to/new/data")

📊 Benchmarks

We provide standardize benchmarks on action segmentation to help you evaluate DLC2Action's performance. Check out the benchmarks section for detailed results and comparisons.

📚 How to get more information?

Check out the examples or read the documentation for a taste of what else you can do.

🙏 Acknowledgments

DLC2Action is developed by members of the A. Mathis Group at EPFL. We are grateful to many people for feedback, alpha-testing, suggestions and contributions, in particular to Lucas Stoffl, Margaret Lane, Marouane Jaakik, Steffen Schneider and Mackenzie Mathis.

We are also grateful to the creators of the different benchmarks, as well as models that were adapted in DLC2action. In particular, the MS-TCN, the C2F-TCN, the ASFormer, the EDTCN and the MotionBERT models, and the CalMS21, the SIMBA CRIM13 and SIMBA-RAT, the OFT and EPM, the SHOT7m2 and hBABEL, and the Atari-HEAD datasets. Please refer to the benchmarks section for detailed references and consider citing these works when using them.

📝 License

Note that the software is provided "as is", without warranty of any kind, express or implied. If you use the code or data, please cite us!

📑 Reference

Stay tuned for our first publication -- any feedback on this beta release is welcome at this time. Thanks for using DLC2Action. Please reach out if you want to collaborate!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dlc2action-1.0.tar.gz (243.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dlc2action-1.0-py3-none-any.whl (279.9 kB view details)

Uploaded Python 3

File details

Details for the file dlc2action-1.0.tar.gz.

File metadata

  • Download URL: dlc2action-1.0.tar.gz
  • Upload date:
  • Size: 243.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for dlc2action-1.0.tar.gz
Algorithm Hash digest
SHA256 78905a9e675515c63767cd416f8dee340f6c96d635f5a580eb8b2b55c44f2522
MD5 2c4c2bc77ffbac87a06c445993ad44f5
BLAKE2b-256 08b9302b1aee145d6cb4618b4e738a7e3b2de13e95a925b0201a1653cc96d21c

See more details on using hashes here.

File details

Details for the file dlc2action-1.0-py3-none-any.whl.

File metadata

  • Download URL: dlc2action-1.0-py3-none-any.whl
  • Upload date:
  • Size: 279.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for dlc2action-1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e8fe15aa22f08f4a37953136bbc4bfdf8b1cec16dfc357c4e62ecf3943839e20
MD5 adef59ccb00b3c6adecb671c6a7da986
BLAKE2b-256 e4a14507151a379b4a62ba55dbaeb875284069aff49c93c9e81e899414bb0869

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page