Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SimonBlanke committed Aug 19, 2021
1 parent 858da23 commit 19425f5
Showing 1 changed file with 24 additions and 8 deletions.
32 changes: 24 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -946,17 +946,33 @@ A combination between simulated annealing and random search.
<summary><b> Read this before opening a bug-issue </b></summary>

<br>

- <b>Are you sure the bug is located in Hyperactive? </b>

Are you sure the bug is located in Hyperactive?

Look at the error message from the command line. <b>If</b> one of the last messages look like this:
- File "/.../gradient_free_optimizers/...", line ...

<b>Then</b> you should post the bug report in:
- https://github.com/SimonBlanke/Gradient-Free-Optimizers
The error might be located in the optimization-backend.
Look at the error message from the command line. <b>If</b> one of the last messages look like this:
- File "/.../gradient_free_optimizers/...", line ...

<b>Otherwise</b> you can post the bug report in Hyperactive
<b>Then</b> you should post the bug report in:
- https://github.com/SimonBlanke/Gradient-Free-Optimizers

<br>Otherwise</b> you can post the bug report in Hyperactive

- <b>Do you have the correct Hyperactive version? </b>

Every major version update (e.g. v2.2 -> v3.0) the API of Hyperactive changes.
Check which version of Hyperactive you have. If your major version is older you have two options:

<b>Recommended:</b> You could just update your Hyperactive version with:
```bash
pip install hyperactive --upgrade
```
This way you can use all the new documentation and examples from the current repository.

Or you could continue using the old version and use an old repository branch as documentation.
You can do that by selecting the corresponding branch. (top right of the repository. The default is "master" or "main")
So if your major version is older (e.g. v2.1.0) you can select the 2.x.x branch to get the old repository for that version.

</details>


Expand Down

0 comments on commit 19425f5

Please sign in to comment.