Open shrivaths16 opened 5 months ago
The recent changes introduce a new branch trigger for the GitHub workflow and add comprehensive documentation for using Bonsai with SLEAP. The updates include a new guide on exporting SLEAP models, installing Bonsai, and employing Bonsai SLEAP modules for prediction and analysis, along with a new section in the documentation index.
File | Change Summary |
---|---|
.github/workflows/website.yml |
Added a branch trigger shrivaths/bonsai-guide for paths docs/** and README.rst . |
docs/guides/bonsai.md |
Introduced a guide on using Bonsai with SLEAP, covering model export, installation, and usage. |
docs/guides/index.md |
Added a section titled "SLEAP with Bonsai" for visual analysis of trained SLEAP models. |
In the code where branches grow,
A new trigger starts to show. 🌿
Bonsai and SLEAP now intertwine,
Predictions bloom, results align.
Docs updated, clear and bright,
Guiding coders day and night.
🌟 A garden of knowledge takes flight! 🚀
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Description
Currently we do not have a page that helps in understanding on how to use Bonsai and SLEAP together for analysis. So, adding a Bonsai guide page to the website for a guidance on using SLEAP models in Bonsai.
Types of changes
Does this address any currently open issues?
1778
Outside contributors checklist
[ ] Review the guidelines for contributing to this repository
[ ] Read and sign the CLA and add yourself to the authors list
[ ] Make sure you are making a pull request against the develop branch (not main). Also you should start your branch off develop
[ ] Add tests that prove your fix is effective or that your feature works
[ ] Add necessary documentation (if appropriate)
Thank you for contributing to SLEAP!
:heart:
Summary by CodeRabbit
New Features
Documentation