Skip to content

Commit aa2f2cc

Browse files
gitttt-1234claude
andauthored
Update documentation and Colab links from main to develop branch (#2481)
Updates all GitHub and Colab notebook links to reference the develop branch instead of main, ensuring users access the correct version of files and notebooks. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude <[email protected]>
1 parent 5f6eb12 commit aa2f2cc

13 files changed

+15
-15
lines changed

docs/guides/creating-a-custom-training-profile.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Hyperparameters include the model architecture, learning rate, and data augmenta
44

55
This guide will explain how to create a custom training profile but doesn't cover how to decide what the hyperparameters should be. For more information about the hyperparameters, see our guide to [Configuring models](../learnings/configuring-models.md).
66

7-
Training profiles are YAML files. The YAML format is fairly easy to read (and edit) with a text-editor and you can use the default "baseline" profiles as a starting point for creating your own training profiles. For example, take a look at the [baseline bottom-up profile](https://github.com/talmolab/sleap/blob/main/sleap/training_profiles/baseline_medium_rf.bottomup.json) or our [other baseline profiles](https://github.com/talmolab/sleap/blob/main/sleap/training_profiles).
7+
Training profiles are YAML files. The YAML format is fairly easy to read (and edit) with a text-editor and you can use the default "baseline" profiles as a starting point for creating your own training profiles. For example, take a look at the [baseline bottom-up profile](https://github.com/talmolab/sleap/blob/develop/sleap/training_profiles/baseline_medium_rf.bottomup.yaml) or our [other baseline profiles](https://github.com/talmolab/sleap/blob/develop/sleap/training_profiles).
88

99
But if this sounds intimidating, you don't have to edit the YAML file by hand! You can use the same GUI that's used for training on a local machine to export custom training profiles.
1010

docs/help.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,4 +129,4 @@ To help us improve SLEAP, you may allow us to collect basic and **anonymous** us
129129

130130
This helps us understand on which types of computers SLEAP is being used so we can ensure that our software is maximally accessible to the broadest userbase possible, for example, by telling us whether it's safe to update our dependencies without breaking SLEAP for most users. Collecting usage data also helps us get a sense for how often SLEAP is being used so that we can report its impact to external grant funding agencies.
131131

132-
You can opt out at any time from the menu (this preference will be stored). If you want to prevent these data from being shared with us, you can launch the GUI with `sleap-label --no-usage-data`. Usage data is only shared when the GUI is used, not the API or CLIs. You can check out the [source code](https://github.com/talmolab/sleap/blob/main/sleap/gui/web.py) to see exactly what data is collected.
132+
You can opt out at any time from the menu (this preference will be stored). If you want to prevent these data from being shared with us, you can launch the GUI with `sleap-label --no-usage-data`. Usage data is only shared when the GUI is used, not the API or CLIs. You can check out the [source code](https://github.com/talmolab/sleap/blob/develop/sleap/gui/web.py) to see exactly what data is collected.

docs/notebooks/Analysis_examples.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"id": "view-in-github"
88
},
99
"source": [
10-
"<a href=\"https://colab.research.google.com/github/talmolab/sleap/blob/main/docs/notebooks/Analysis_examples.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
10+
"<a href=\"https://colab.research.google.com/github/talmolab/sleap/blob/develop/docs/notebooks/Analysis_examples.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
1111
]
1212
},
1313
{

docs/notebooks/Data_structures.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"id": "view-in-github"
88
},
99
"source": [
10-
"<a href=\"https://colab.research.google.com/github/talmolab/sleap/blob/main/docs/notebooks/Data_structures.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
10+
"<a href=\"https://colab.research.google.com/github/talmolab/sleap/blob/develop/docs/notebooks/Data_structures.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
1111
]
1212
},
1313
{

docs/notebooks/Interactive_and_realtime_inference.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"id": "view-in-github"
88
},
99
"source": [
10-
"<a href=\"https://colab.research.google.com/github/talmolab/sleap/blob/main/docs/notebooks/Interactive_and_realtime_inference.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
10+
"<a href=\"https://colab.research.google.com/github/talmolab/sleap/blob/develop/docs/notebooks/Interactive_and_realtime_inference.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
1111
]
1212
},
1313
{

docs/notebooks/Interactive_and_resumable_training.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"id": "view-in-github"
88
},
99
"source": [
10-
"<a href=\"https://colab.research.google.com/github/talmolab/sleap/blob/main/docs/notebooks/Interactive_and_resumable_training.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
10+
"<a href=\"https://colab.research.google.com/github/talmolab/sleap/blob/develop/docs/notebooks/Interactive_and_resumable_training.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
1111
]
1212
},
1313
{

docs/notebooks/Model_evaluation.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"id": "view-in-github"
77
},
88
"source": [
9-
"<a href=\"https://colab.research.google.com/github/talmolab/sleap/blob/main/docs/notebooks/Model_evaluation.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
9+
"<a href=\"https://colab.research.google.com/github/talmolab/sleap/blob/develop/docs/notebooks/Model_evaluation.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
1010
]
1111
},
1212
{

docs/notebooks/Post_inference_tracking.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"id": "view-in-github"
88
},
99
"source": [
10-
"<a href=\"https://colab.research.google.com/github/talmolab/sleap/blob/main/docs/notebooks/Post_inference_tracking.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
10+
"<a href=\"https://colab.research.google.com/github/talmolab/sleap/blob/develop/docs/notebooks/Post_inference_tracking.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
1111
]
1212
},
1313
{

docs/notebooks/Training_and_inference_on_an_example_dataset.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"id": "view-in-github"
88
},
99
"source": [
10-
"<a href=\"https://colab.research.google.com/github/talmolab/sleap/blob/main/docs/notebooks/Training_and_inference_on_an_example_dataset.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
10+
"<a href=\"https://colab.research.google.com/github/talmolab/sleap/blob/develop/docs/notebooks/Training_and_inference_on_an_example_dataset.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
1111
]
1212
},
1313
{

docs/notebooks/Training_and_inference_using_Google_Drive.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"id": "view-in-github"
77
},
88
"source": [
9-
"<a href=\"https://colab.research.google.com/github/talmolab/sleap/blob/main/docs/notebooks/Training_and_inference_using_Google_Drive.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
9+
"<a href=\"https://colab.research.google.com/github/talmolab/sleap/blob/develop/docs/notebooks/Training_and_inference_using_Google_Drive.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
1010
]
1111
},
1212
{

0 commit comments

Comments
 (0)