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

1085 runhistory documentation #1175

Merged
merged 7 commits into from
Dec 2, 2024
Merged

Conversation

benjamc
Copy link
Collaborator

@benjamc benjamc commented Dec 2, 2024

Output of runhistory not well documented, related: #1174

(First step to update docs, then code bc changing code has downstream consequences of libs like DeepCAVE)

Closes #1085

},
```

Lastly, `config_origins` contains the origin of a configuration.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add, that origins can be the from the initial design or from different acquisition function maximization techniques

]
```

`configs` contains a human readable dictionary of configurations. Note that this list starts by one, therefore the 0 entry from above is mapped to 1.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rephrase: The config ids are 1-based. (just leave out the last half-sentence, it confused me a bit)

Copy link
Collaborator

@LukasFehring LukasFehring Dec 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The problem is that in the data part, the values are actually not starting at config_index 1, but at config_index 0. This has previously caused issues in multiple implementations :)
I will find a better way to put this :)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah okay thanks!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

weird that it is logged like this 😅

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. It is one of the reasons why I want to revamp it. I am also confused by even separating the two different dictionaries. Would it not be nicer as a normal json?

@benjamc benjamc marked this pull request as ready for review December 2, 2024 13:52
@benjamc
Copy link
Collaborator Author

benjamc commented Dec 2, 2024

LGTM

@benjamc benjamc merged commit 9176ca6 into development Dec 2, 2024
16 checks passed
@benjamc benjamc deleted the 1085-runhistory_documentation branch December 2, 2024 14:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants