DeepLabCut · MMathisLab · May 1, 2023 · Apr 27, 2023 · Apr 27, 2023 · Apr 27, 2023
diff --git a/.codespellrc b/.codespellrc
@@ -0,0 +1,5 @@
+[codespell]
+skip = .git,*.pdf,*.svg,deeplabcut/pose_estimation_tensorflow/models/pretrained
+# MOT,SIE - legit acronyms
+# tThe - for \tThe. codespell is not good detecting those yet
+ignore-words-list = mot,sie,tthe
diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml
@@ -0,0 +1,19 @@
+---
+name: Codespell
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v1
diff --git a/deeplabcut/create_project/modelzoo.py b/deeplabcut/create_project/modelzoo.py
@@ -21,7 +21,7 @@
     MODELOPTIONS,
 )
 
-Modeloptions = MODELOPTIONS  # backwards compatability for COLAB NOTEBOOK
+Modeloptions = MODELOPTIONS  # backwards compatibility for COLAB NOTEBOOK
 
 
 def MakeTrain_pose_yaml(itemstochange, saveasconfigfile, defaultconfigfile):

diff --git a/deeplabcut/generate_training_dataset/multiple_individuals_trainingsetmanipulation.py b/deeplabcut/generate_training_dataset/multiple_individuals_trainingsetmanipulation.py
@@ -115,7 +115,7 @@ def create_multianimaltraining_dataset(
     Only the videos included in the config file are used to create this dataset.\n
     [OPTIONAL] Use the function 'add_new_videos' at any stage of the project to add more videos to the project.
 
-    Imporant differences to standard:
+    Important differences to standard:
      - stores coordinates with numdigits as many digits
      - creates
     Parameter

diff --git a/deeplabcut/pose_estimation_3d/triangulation.py b/deeplabcut/pose_estimation_3d/triangulation.py
@@ -546,7 +546,7 @@ def undistort_points(config, dataframe, camera_pair):
     filename_cam1 = Path(dataframe[0]).stem
     filename_cam2 = Path(dataframe[1]).stem
 
-    #currently no interm. saving of this due to high speed.
+    #currently no intermediate saving of this due to high speed.
     # check if the undistorted files are already present
     if os.path.exists(os.path.join(path_undistort,filename_cam1 + '_undistort.h5')) and os.path.exists(os.path.join(path_undistort,filename_cam2 + '_undistort.h5')):
         print("The undistorted files are already present at %s" % os.path.join(path_undistort,filename_cam1))

diff --git a/deeplabcut/utils/auxiliaryfunctions_3d.py b/deeplabcut/utils/auxiliaryfunctions_3d.py
@@ -304,7 +304,7 @@ def _associate_paired_view_tracks(tracklets1, tracklets2, F):
     Parameters:
     -----------
     tracklets1/2: Tracklet() object (defined in stitch.py)
-    F: nd.array
+    F: numpy.ndarray
         Fundamental matrix between cam1 and cam2
     """
     from scipy.optimize import linear_sum_assignment

diff --git a/docs/ModelZoo.md b/docs/ModelZoo.md
@@ -6,7 +6,7 @@
 
 Started in 2020 and expanded in 2022, the model zoo is four things:
 
-- (1) a collection of models that are trained on diverse data across (typically) large datsets, which means you do not need to train models yourself
+- (1) a collection of models that are trained on diverse data across (typically) large datasets, which means you do not need to train models yourself
 - (2) a contribution website for community crowd sourcing of expertly labeled keypoints to improve models in part 1!
 - (3) a no-install DeepLabCut that you can use on ♾[Google Colab](https://colab.research.google.com/github/DeepLabCut/DeepLabCut/blob/master/examples/COLAB/COLAB_DLC_ModelZoo.ipynb), 
 test our models in 🕸[the browser](https://contrib.deeplabcut.org/), or on our 🤗[HuggingFace](https://huggingface.co/spaces/DeepLabCut/MegaDetector_DeepLabCut) app!

diff --git a/docs/recipes/installTips.md b/docs/recipes/installTips.md
@@ -342,7 +342,7 @@ conda env create -f DEEPLABCUT_M1.yaml
 conda activate DEEPLABCUT_M1
 conda env config vars set CONDA_SUBDIR=osx-64
 ```
-Now, as the print satement says, please deactivate and re-activate to set the change:
+Now, as the print statement says, please deactivate and re-activate to set the change:
 
 ```
 conda deactivate

diff --git a/tests/test_trackingutils.py b/tests/test_trackingutils.py
@@ -54,9 +54,9 @@ def test_ellipse_tracker(ellipse):
 
 def test_sort_ellipse():
     tracklets = dict()
-    mot = trackingutils.SORTEllipse(1, 1, 0.6)
+    mot_tracker = trackingutils.SORTEllipse(1, 1, 0.6)
     poses = np.random.rand(2, 10, 3)
-    trackers = mot.track(poses[..., :2])
+    trackers = mot_tracker.track(poses[..., :2])
     assert trackers.shape == (2, 7)
     trackingutils.fill_tracklets(tracklets, trackers, poses, imname=0)
     assert all(id_ in tracklets for id_ in trackers[:, -2])