Skip to content

Commit 1a9a92f

Browse files
committed
move modules to private for now
1 parent 33438bd commit 1a9a92f

11 files changed

Lines changed: 7 additions & 76 deletions

File tree

docs/source/api_reference.rst

Lines changed: 0 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -220,43 +220,3 @@ Control output during search:
220220
verbosity = ["progress_bar"] # Progress bar only
221221
verbosity = ["print_results"] # Print final results
222222
verbosity = ["progress_bar", "print_results"] # Both (default)
223-
224-
225-
Distributed Evaluation
226-
----------------------
227-
228-
Backends for parallel objective function evaluation. Sync backends evaluate
229-
full batches, async backends process results as they arrive.
230-
231-
.. code-block:: python
232-
233-
from gradient_free_optimizers.distributed import Joblib, Ray, Dask
234-
235-
.. autosummary::
236-
:toctree: api_reference/generated/
237-
:template: class.rst
238-
239-
gradient_free_optimizers.distributed.BaseDistribution
240-
gradient_free_optimizers.distributed.Multiprocessing
241-
gradient_free_optimizers.distributed.Joblib
242-
gradient_free_optimizers.distributed.Ray
243-
gradient_free_optimizers.distributed.Dask
244-
245-
246-
Evaluation Storage
247-
------------------
248-
249-
Pluggable backends for caching objective function evaluations. Pass a storage
250-
instance to the ``memory`` parameter of ``search()``.
251-
252-
.. code-block:: python
253-
254-
from gradient_free_optimizers.storage import SQLiteStorage
255-
256-
.. autosummary::
257-
:toctree: api_reference/generated/
258-
:template: class.rst
259-
260-
gradient_free_optimizers.storage.BaseStorage
261-
gradient_free_optimizers.storage.MemoryStorage
262-
gradient_free_optimizers.storage.SQLiteStorage

docs/source/user_guide.rst

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -149,13 +149,6 @@ Guide Sections
149149
Using the simple ``.search()``
150150
method.
151151

152-
.. grid-item-card:: Evaluation Storage
153-
:link: user_guide/storage
154-
:link-type: doc
155-
156-
Persistent caching and crash
157-
recovery with pluggable backends.
158-
159152
----
160153

161154
Algorithms
@@ -219,7 +212,6 @@ GFO provides 22 optimization algorithms organized into four categories:
219212
user_guide/memory
220213
user_guide/stopping_conditions
221214
user_guide/search_interface
222-
user_guide/storage
223215

224216
.. toctree::
225217
:maxdepth: 2

docs/source/user_guide/distributed.rst

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -191,27 +191,6 @@ failed evaluation:
191191
opt.search(flaky_model, n_iter=100, catch={ValueError: -1000.0})
192192
193193
194-
Storage Integration
195-
-------------------
196-
197-
Distributed evaluation works with :doc:`storage backends <storage>`. Positions
198-
are checked against the cache before being dispatched to workers, and new
199-
results are stored after evaluation. This avoids redundant computations and
200-
enables crash recovery:
201-
202-
.. code-block:: python
203-
204-
from gradient_free_optimizers.distributed import Joblib
205-
from gradient_free_optimizers.storage import SQLiteStorage
206-
207-
@Joblib(n_workers=4).distribute
208-
def model(para):
209-
return expensive_training(para)
210-
211-
storage = SQLiteStorage("results.db")
212-
opt.search(model, n_iter=100, memory=storage)
213-
214-
215194
Custom Backends
216195
---------------
217196

src/gradient_free_optimizers/_memory.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
import pandas as pd
1111

1212
from ._objective_adapter import ObjectiveAdapter
13-
from .storage import BaseStorage, MemoryStorage
13+
from ._storage import BaseStorage, MemoryStorage
1414

1515

1616
class CachedObjectiveAdapter(ObjectiveAdapter):

src/gradient_free_optimizers/storage/__init__.py renamed to src/gradient_free_optimizers/_storage/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Storage backends control where objective function evaluation results are
44
persisted. They can be passed to the ``memory`` parameter of ``search()``::
55
6-
from gradient_free_optimizers.storage import SQLiteStorage
6+
from gradient_free_optimizers._storage import SQLiteStorage
77
88
storage = SQLiteStorage("results.db")
99
opt.search(objective, n_iter=100, memory=storage)
File renamed without changes.
File renamed without changes.
File renamed without changes.

src/gradient_free_optimizers/search.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@
2222
from ._results_manager import ResultsManager
2323
from ._search_statistics import SearchStatistics
2424
from ._stopping_conditions import OptimizationStopper
25+
from ._storage import BaseStorage
2526
from ._times_tracker import TimesTracker
26-
from .storage import BaseStorage
2727

2828
if TYPE_CHECKING:
2929
import pandas as pd
@@ -212,10 +212,10 @@ def objective_with_metrics(params):
212212
Controls evaluation caching. When ``True``, uses an in-memory
213213
dictionary (equivalent to ``MemoryStorage()``). When ``False``,
214214
disables caching entirely. A
215-
:class:`~gradient_free_optimizers.storage.BaseStorage` instance
215+
:class:`~gradient_free_optimizers._storage.BaseStorage` instance
216216
enables custom storage backends::
217217
218-
from gradient_free_optimizers.storage import SQLiteStorage
218+
from gradient_free_optimizers._storage import SQLiteStorage
219219
opt.search(objective, memory=SQLiteStorage("results.db"))
220220
221221
``SQLiteStorage`` persists results to disk, enabling crash

tests/test_main/test_distributed.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
Joblib,
2020
Multiprocessing,
2121
)
22-
from gradient_free_optimizers.storage import MemoryStorage
22+
from gradient_free_optimizers._storage import MemoryStorage
2323

2424
search_space = {"x": np.linspace(-10, 10, 100), "y": np.linspace(-10, 10, 100)}
2525
tiny_space = {"x": np.linspace(0, 1, 10)}

0 commit comments

Comments
 (0)