Add doc on joblib

docs/conf.py

@@ -212,39 +212,42 @@
 # -- Sphinx-Gallery configuration --------------------------------------------
 
 
-class SubSectionTitleOrder:
-    """Sort example gallery by title of subsection.
+# class SubSectionTitleOrder:
+#     """Sort example gallery by title of subsection.
 
-    Assumes README.txt exists for all subsections and uses the subsection with
-    dashes, '---', as the adornment.
-    """
+#     Assumes README.txt exists for all subsections and uses the subsection with
+#     dashes, '---', as the adornment.
+#     """
 
-    def __init__(self, src_dir):
-        self.src_dir = src_dir
-        self.regex = re.compile(r"^([\w ]+)\n-", re.MULTILINE)
+#     def __init__(self, src_dir):
+#         self.src_dir = src_dir
+#         self.regex = re.compile(r"^([\w ]+)\n-", re.MULTILINE)
 
-    def __repr__(self):
-        return f"<{self.__class__.__name__}>"
+#     def __reduce__(self):
+#         return (self.__class__, (self.src_dir, ))
 
-    def __call__(self, directory):
-        src_path = os.path.normpath(os.path.join(self.src_dir, directory))
+#     def __repr__(self):
+#         return f"<{self.__class__.__name__}>"
 
-        # Forces Release Highlights to the top
-        if os.path.basename(src_path) == "release_highlights":
-            return "0"
+#     def __call__(self, directory):
+#         src_path = os.path.normpath(os.path.join(self.src_dir, directory))
 
-        readme = os.path.join(src_path, "README.txt")
+#         # Forces Release Highlights to the top
+#         if os.path.basename(src_path) == "release_highlights":
+#             return "0"
 
-        try:
-            with open(readme) as f:
-                content = f.read()
-        except FileNotFoundError:
-            return directory
+#         readme = os.path.join(src_path, "README.txt")
 
-        title_match = self.regex.search(content)
-        if title_match is not None:
-            return title_match.group(1)
-        return directory
+#         try:
+#             with open(readme) as f:
+#                 content = f.read()
+#         except FileNotFoundError:
+#             return directory
+
+#         title_match = self.regex.search(content)
+#         if title_match is not None:
+#             return title_match.group(1)
+#         return directory
 
 
 ex_dirs = [
@@ -269,7 +272,7 @@ def __call__(self, directory):
     "examples_dirs": example_dirs,
     "gallery_dirs": gallery_dirs,
     "nested_sections": True,
-    "subsection_order": SubSectionTitleOrder("../examples"),
+    # "subsection_order": SubSectionTitleOrder("../examples"),
     "filename_pattern": "/(plot|run)_",
     "download_all_examples": False,
 }

docs/selected_deeper_topics/joblib.rst

@@ -14,4 +14,7 @@ computed in parallel.
 Without going into details about parallel and distributed computing, the idea
 is to split the computation into smaller tasks that can be executed
 independently from each other. This way, you can take advantage of multiple
-*processors* to do them in parallel.
+*processors* to do them in parallel. A very clear example of this situation is
+when you are estimating a model's performance using cross-validation. In this
+case, you can parallelize the computation of the different folds, as the
+training and testing of each fold are independent from each other.