Skip to content

Commit

Permalink
Add DeepLabCut MyST mini-hackathon blog post
Browse files Browse the repository at this point in the history
  • Loading branch information
jnywong committed Sep 2, 2024
1 parent b7a686b commit 0aafbee
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
45 changes: 45 additions & 0 deletions content/blog/2024/deeplabcut-myst-hackathon/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: MyST Mini-Hackathon with the DeepLabCut Team
date: "2024-09-02"
banner:
image: "featured.png"
authors: ["Jenny Wong", "Angus Hollands", "Chris Holdgraf"]
tags: [bioscience, open source]
categories: [impact]
featured: false
draft: false
---

## The DeepLabCut Team

The [DeepLabCut team](http://www.mackenziemathislab.org/deeplabcut) is a group of researchers and developers who are working on open source tools for analyzing animal pose estimation by training deep neural networks on videos.

![Animal pose estimation using deep neural networks. Courtesy of the DeepLabCut Jupyter Book](https://images.squarespace-cdn.com/content/v1/57f6d51c9f74566f55ecf271/daed7f16-527f-4150-8bdd-cbb20e267451/cheetah-ezgif.com-video-to-gif-converter.gif?format=180w "Animal pose estimation using deep neural networks. Courtesy of the [DeepLabCut Jupyter Book](https://deeplabcut.github.io/DeepLabCut/README.html)")

Chris Holdgraf visited the lab in early August to learn more about how the group were using open-source tools to document and share their work.

## Jupyter Book and MyST

Extensive documentation for using the DeepLabCut software package is already available as a [Jupyter Book](https://deeplabcut.github.io/DeepLabCut/README.html). The group was interested in adopting MyST Markdown to stay ahead of the curve and upgrade their Jupyter Book (see the related announcement [Jupyter Book 2 will be build upon the MyST-MD engine](https://executablebooks.org/en/latest/blog/2024-05-20-jupyter-book-myst/)).

Chris led a mini-hackathon to introduce the group to MyST and collect feedback on where enhancement features could be made in the future. Here's a summary of the outcomes:

- Many improvements were made to the [MyST documentation](https://mystmd.org/guide/) 📖
- The [MyST Quick Start Guide](https://mystmd.org/guide/quickstart) was used to onboard new users. Amendments were [upstreamed to the MyST docs directly](https://github.com/jupyter-book/mystmd/pull/1433) and were immediately available to all.
- A [tutorial on executable documents](https://mystmd.org/guide/quickstart-executable-documents) was added to the collection of MyST tutorials.
- MyST-MD installation instructions were [simplified using `mamba`](https://github.com/jupyter-book/mystmd/pull/1454).
- A bunch of enhancement features were requested ✨
- [Using cell tags for labelling notebook cells](https://github.com/jupyter-book/mystmd/issues/1455)
- [Support for loading user-defined CSS stylesheets for theming](https://github.com/jupyter-book/myst-theme/issues/321)
- [Better UX for mult-versioned documentation](https://github.com/jupyter-book/mystmd/issues/1458)
- [Bibliography styling in HTML](https://github.com/jupyter-book/mystmd/issues/1462)
- [Automatic API documentation generation](https://github.com/DeepLabCut/DeepLabCut/pull/2712)
- And we found a bug in the [table of contents validation](https://github.com/jupyter-book/mystmd/issues/1456) 🐞

## Summary

Hackathons are a great way for quickly imparting knowledge and gathering feedback in a short space of time. The event spurred rapid contributions to the MyST ecosystem – embracing reuse of the MyST quick start guides saved time and effort, while engaging with users directly closed a tight feedback loop for enhancements.

## Acknowledgments

We would like to thank the [Makenzie Mathis Lab](http://www.mackenziemathislab.org/) for hosting Chris Holdgraf at EPFL, Lausanne, Switzerland.

0 comments on commit 0aafbee

Please sign in to comment.