Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update _toc.yml - removes readme from jupyterbook docs, as it's redundant. * Update README.md
- Loading branch information
1 parent
43dcffe
commit 7208a7c
Showing
2 changed files
with
2 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,44 +1,3 @@ | ||
| (readme)= | ||
| # Welcome to Our Documentation Hub! | ||
| Please see https://deeplabcut.github.io/DeepLabCut/docs/intro.html for documentation on how to use this software. | ||
|
|
||
| <img src="https://images.squarespace-cdn.com/content/v1/57f6d51c9f74566f55ecf271/1572296495650-Y4ZTJ2XP2Z9XF1AD74VW/ke17ZwdGBToddI8pDm48kMulEJPOrz9Y8HeI7oJuXxR7gQa3H78H3Y0txjaiv_0fDoOvxcdMmMKkDsyUqMSsMWxHk725yiiHCCLfrh8O1z5QPOohDIaIeljMHgDF5CVlOqpeNLcJ80NK65_fV7S1UZiU3J6AN9rgO1lHw9nGbkYQrCLTag1XBHRgOrY8YAdXW07ycm2Trb21kYhaLJjddA/DLC_logo_blk-01.png?format=1000w" width="150" title="DLC-live" alt="DLC LIVE!" align="right" vspace = "50"> | ||
|
|
||
| If you are new to DeepLabCut, we have 3 resources we recommend before jumping in. (1) Please first [read at the Nature Protocol paper](https://www.nature.com/articles/s41596-019-0176-0); (2) Check out the [quick video on navigating the docs](https://www.youtube.com/watch?v=A9qZidI7tL8); (3) Check out the [free DeepLabCut Course](https://github.com/DeepLabCut/DeepLabCut-Workshop-Materials/blob/master/DLCcourse.md): we have put together a "course" on the science of DeepLabCut and how to use it. | ||
|
|
||
|
|
||
|
|
||
| **Otherwise, here are the links to all the key steps to get you up and running within a day!** | ||
|
|
||
| - **[How to install DeepLabCut](how-to-install)** | ||
|
|
||
| - Decide on your needs: there are **two main modes, standard DeepLabCut or multi-animal DeepLabCut**. We highly recommend carefully considering which one is best for your needs. For example, a white mouse + black mouse would call for standard, while two black mice would use multi-animal. **[Important Information on how to use DLC in different scenarios (single vs multi animal)](important-info-regd-usage)** Then pick: | ||
|
|
||
| - **[How to use standard DeepLabCut](single-animal-userguide)** | ||
| - **[How to use multi-animal DeepLabCut](multi-animal-userguide)** | ||
|
|
||
|
|
||
| ## More resources for help, additional docs, and roadmap of the project! | ||
|
|
||
| [CLICK to launch an interactive graphic that walks you through more resources!](https://view.genial.ly/5fb40a49f8a0ef13943d4e5e/horizontal-infographic-review-learning-to-use-deeplabcut) (mini preview below) | ||
|
|
||
| <p align="left"> | ||
| <img src="https://images.squarespace-cdn.com/content/v1/57f6d51c9f74566f55ecf271/1605642639913-OIUBVR8R0JLYZQPRIYIR/ke17ZwdGBToddI8pDm48kMMAxEenKbh651VJujierMxZw-zPPgdn4jUwVcJE1ZvWQUxwkmyExglNqGp0IvTJZUJFbgE-7XRK3dMEBRBhUpw-CO5bsXt3Lwn3O5kv-PfTgGtLU9oye8D4J7Fixq38Gl-o9tfrEtbnqpPzC5bXTas/ezgif.com-gif-maker.gif?format=750w" width="95%"> | ||
| </p> | ||
|
|
||
| - [Real-time feedback with DeepLabCut: DeepLabCut-live](https://github.com/DeepLabCut/DeepLabCut-live) | ||
|
|
||
| - [DeepLabCut 3D](3D-overview) | ||
|
|
||
| - [Helper functions](helper-functions) | ||
|
|
||
| - [Developer Road Map!](dev-roadmap) | ||
|
|
||
| - [How to Contribute to DeepLabCut](https://github.com/DeepLabCut/DeepLabCut/blob/master/CONTRIBUTING.md) and the [Code of Conduct](https://github.com/DeepLabCut/DeepLabCut/blob/master/CODE_OF_CONDUCT.md) | ||
|
|
||
| - [The Authors of DeepLabCut](https://github.com/DeepLabCut/DeepLabCut/blob/master/AUTHORS) | ||
|
|
||
| A quick video to help you navigate the docs: **Click on the image!** | ||
|
|
||
| [](https://www.youtube.com/watch?v=A9qZidI7tL8) | ||
|
|
||
| - Please note: what we cannot do is provided support or help designing your experiments and data analysis. The number of requests for this is too great to sustain in our inbox. We are happy to answer such questions in the forum as a community, in a scalable way. We hope and believe we have given enough tools and resources to get started and to accelerate your research program, and this is backed by the >700 citations using DLC, 2 clinical trials by others, and countless applications. Thus, we believe this code works, is accessible, and with limited programming knowledge can be used. Please read our Missions & Values statement to learn more about what we DO hope to provide you. | ||
| This directory contains the source code for the docs. |