Skip to content

Commit

Permalink
fix(docs): site build dir + links
Browse files Browse the repository at this point in the history
  • Loading branch information
benjamc committed Jan 20, 2025
1 parent 78eb17d commit 2deab52
Show file tree
Hide file tree
Showing 7 changed files with 6 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/advanced_usage/10_continue.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ The behavior can be controlled by setting the parameter ``overwrite`` in the fac
and the old run is not affected.


Please have a look at our [continue example](../examples/1%20Basics/5_continue.html).
Please have a look at our [continue example](../examples/1%20Basics/5_continue.md).
2 changes: 1 addition & 1 deletion docs/advanced_usage/3_multi_objective.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ use the method ``get_incumbents`` in the intensifier.
incumbents = smac.intensifier.get_incumbents()
```

We show an example of how to use multi-objective with plots in our [examples](../examples/3%20Multi-Objective/1_schaffer.html).
We show an example of how to use multi-objective with plots in our [examples](../examples/3%20Multi-Objective/1_schaffer.md).
2 changes: 1 addition & 1 deletion docs/advanced_usage/5.1_warmstarting.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ class TrialInfo:
```

## Usage Example
See [`examples/1_basics/8_warmstart.py`](../../examples/1%20Basics/8_warmstart.py).
See [`examples/1_basics/8_warmstart.py`](../examples/1%20Basics/8_warmstart.md).


```python
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced_usage/5_ask_and_tell.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ and report the results of the trial.
into the intensification process.


Please have a look at our [ask-and-tell example](../examples/1%20Basics/3_ask_and_tell.html).
Please have a look at our [ask-and-tell example](../examples/1%20Basics/3_ask_and_tell.md).
2 changes: 1 addition & 1 deletion docs/advanced_usage/8_logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Scenario(
...
)
```
Notably, if an output already exists at `./some_directory/experiment_name/seed`, the behavior is determined by the overwrite parameter in the [facade's][smac/facade/abstract_facade] settings. This parameter specifies whether to continue the previous run (default) or start a new run.
Notably, if an output already exists at `./some_directory/experiment_name/seed`, the behavior is determined by the overwrite parameter in the [facade's][smac.facade.abstract_facade] settings. This parameter specifies whether to continue the previous run (default) or start a new run.

The output is split into four different log files, and a copy of the utilized [Configuration Space of the ConfigSpace library](https://automl.github.io/ConfigSpace/latest/).

Expand Down
2 changes: 1 addition & 1 deletion docs/advanced_usage/9_parallelism.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ SMAC supports multiple workers natively via Dask. Just specify ``n_workers`` in
## Running on a Cluster

You can also pass a custom dask client, e.g. to run on a slurm cluster.
See our [parallelism example](../examples/1%20Basics/7_parallelization_cluster.html).
See our [parallelism example](../examples/1%20Basics/7_parallelization_cluster.md).

!!! warning

Expand Down
2 changes: 0 additions & 2 deletions mkdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ site_name: "SMAC3"
repo_url: https://github.com/automl/SMAC3/
repo_name: automl/SMAC3

site_dir: docs/site

theme:
name: material
logo: images/logo.png
Expand Down

0 comments on commit 2deab52

Please sign in to comment.