move distribution module to private for now

SimonBlanke · SimonBlanke · commit fdbe3020a525 · 2026-04-10T19:52:33.000+02:00
diff --git a/docs/source/user_guide.rst b/docs/source/user_guide.rst
@@ -149,13 +149,6 @@ Guide Sections
       Using the simple ``.search()``
       method.
 
-   .. grid-item-card:: Distributed Evaluation
-      :link: user_guide/distributed
-      :link-type: doc
-
-      Parallel evaluation across
-      multiple workers.
-
    .. grid-item-card:: Evaluation Storage
       :link: user_guide/storage
       :link-type: doc
@@ -226,7 +219,6 @@ GFO provides 22 optimization algorithms organized into four categories:
    user_guide/memory
    user_guide/stopping_conditions
    user_guide/search_interface
-   user_guide/distributed
    user_guide/storage
 
 .. toctree::
diff --git a/src/gradient_free_optimizers/_distributed/__init__.py b/src/gradient_free_optimizers/_distributed/__init__.py
@@ -3,7 +3,7 @@
 Use a distribution backend as a decorator on your objective function
 to enable parallel batch evaluation during optimization::
 
-    from gradient_free_optimizers.distributed import Multiprocessing
+    from gradient_free_optimizers._distributed import Multiprocessing
 
     @Multiprocessing(n_workers=4).distribute
     def objective(para):
diff --git a/src/gradient_free_optimizers/_distributed/_base.py b/src/gradient_free_optimizers/_distributed/_base.py
diff --git a/src/gradient_free_optimizers/_distributed/_dask.py b/src/gradient_free_optimizers/_distributed/_dask.py
@@ -37,7 +37,7 @@ class Dask(BaseDistribution):
     --------
     Local cluster (created automatically)::
 
-        from gradient_free_optimizers.distributed import Dask
+        from gradient_free_optimizers._distributed import Dask
 
         @Dask(n_workers=4).distribute
         def objective(para):
diff --git a/src/gradient_free_optimizers/_distributed/_joblib.py b/src/gradient_free_optimizers/_distributed/_joblib.py
@@ -33,7 +33,7 @@ class Joblib(BaseDistribution):
     --------
     ::
 
-        from gradient_free_optimizers.distributed import Joblib
+        from gradient_free_optimizers._distributed import Joblib
 
         @Joblib(n_workers=4).distribute
         def objective(para):
diff --git a/src/gradient_free_optimizers/_distributed/_multiprocessing.py b/src/gradient_free_optimizers/_distributed/_multiprocessing.py
@@ -40,7 +40,7 @@ class Multiprocessing(BaseDistribution):
     --------
     ::
 
-        from gradient_free_optimizers.distributed import Multiprocessing
+        from gradient_free_optimizers._distributed import Multiprocessing
 
         @Multiprocessing(n_workers=4).distribute
         def objective(para):
diff --git a/src/gradient_free_optimizers/_distributed/_ray.py b/src/gradient_free_optimizers/_distributed/_ray.py
@@ -37,7 +37,7 @@ class Ray(BaseDistribution):
     --------
     Local usage::
 
-        from gradient_free_optimizers.distributed import Ray
+        from gradient_free_optimizers._distributed import Ray
 
         @Ray(n_workers=4).distribute
         def objective(para):
diff --git a/tests/test_main/test_distributed.py b/tests/test_main/test_distributed.py
@@ -14,7 +14,7 @@
     PowellsMethod,
     RandomSearchOptimizer,
 )
-from gradient_free_optimizers.distributed import (
+from gradient_free_optimizers._distributed import (
     BaseDistribution,
     Joblib,
     Multiprocessing,

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`PowellsMethod,`
`15`	`15`	`RandomSearchOptimizer,`
`16`	`16`	`)`
`17`		`-from gradient_free_optimizers.distributed import (`
	`17`	`+from gradient_free_optimizers._distributed import (`
`18`	`18`	`BaseDistribution,`
`19`	`19`	`Joblib,`
`20`	`20`	`Multiprocessing,`