Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix example link in packages #37

Merged
merged 1 commit into from
May 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package/samplers/demo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ license: 'MIT License'
module = optunahub.load_module("samplers/demo")
sampler = module.DemoSampler(seed=42)
```
See `example.py <example.py>`_ for more details.
See [`example.py`](https://github.com/optuna/optunahub-registry/blob/main/package/samplers/demo/example.py) for more details.
2 changes: 1 addition & 1 deletion package/samplers/evo_merge/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ for _ in range(100):

print(study.trials_dataframe(attrs=("number", "value")))
```
See `example.py` for a full example. You need GPU with 16G VLAM to run this example.
See [`example.py`](https://github.com/optuna/optunahub-registry/blob/main/package/samplers/evo_merge/example.py) for a full example. You need GPU with 16G VLAM to run this example.
The following figures are obtained from the analysis of the optimization.
![History Plot](images/history.png "History Plot")
![Parallel Coordinate Plot](images/parallel_coordinate.png "Parallel Coordinate Plot")
Expand Down
2 changes: 1 addition & 1 deletion package/samplers/simple/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ class UserDefinedSampler(
):
...
```
See `example.py <example.py>`_ for more details.
See [`example.py`](https://github.com/optuna/optunahub-registry/blob/main/package/samplers/simple/example.py) for more details.

## Others
This package provides an easy sampler base class to implement custom samplers.
Expand Down
2 changes: 1 addition & 1 deletion package/samplers/simulated_annealing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ license: 'MIT License'
mod = optunahub.load_module("samplers/simulated_annealing")
sampler = mod.SimulatedAnnealingSampler()
```
See `example.py` for more details.
See [`example.py`](https://github.com/optuna/optunahub-registry/blob/main/package/samplers/simulated_annealing/example.py) for more details.

## Others
This package provides a sampler based on Simulated Annealing algorithm.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ license: 'MIT License'
mod = optunahub.load_module("visualization/plot_hypervolume_history_with_rp")
mod.plot_hypervolume_history(study, reference_point)
```
See `example.py <example.py>`_ for more details.
See [`example.py`](https://github.com/optuna/optunahub-registry/blob/main/package/visualization/plot_hypervolume_history_with_rp/example.py) for more details.
The example of generated image is as follows.

![Example](images/example.png "Example")