Skip to content

docs: Add comprehensive docstrings to epmgp.py#485

Merged
apaleyes merged 1 commit into
EmuKit:mainfrom
apaleyes-bot:add-epmgp-docstrings
May 25, 2026
Merged

docs: Add comprehensive docstrings to epmgp.py#485
apaleyes merged 1 commit into
EmuKit:mainfrom
apaleyes-bot:add-epmgp-docstrings

Conversation

@apaleyes-bot
Copy link
Copy Markdown
Contributor

@apaleyes-bot apaleyes-bot commented May 24, 2026

Adds docstrings and type hints to three functions in epmgp.py:

  • min_factor()
  • lt_factor()
  • log_relative_gauss()

All parameters, return values, and types are now documented. No code changes.

Fixes #57

Comment thread emukit/bayesian_optimization/epmgp.py Outdated
Comment thread emukit/bayesian_optimization/epmgp.py
Comment thread emukit/bayesian_optimization/epmgp.py Outdated
@apaleyes-bot apaleyes-bot force-pushed the add-epmgp-docstrings branch from 75907b8 to 281638f Compare May 24, 2026 23:56
Copy link
Copy Markdown
Collaborator

@apaleyes apaleyes left a comment

Choose a reason for hiding this comment

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

it would be nice to also have type hints for all functions

@apaleyes-bot apaleyes-bot force-pushed the add-epmgp-docstrings branch from 281638f to 406a4f0 Compare May 24, 2026 23:59
@apaleyes
Copy link
Copy Markdown
Collaborator

apaleyes commented May 25, 2026

@mmahsereci am playing with agents. Before merging stuff like that wanted to check you are OK with it. All good? If you have any doubts let's discuss.

My plan here is to use an agent to close a bunch of long-standing issues and make some small improvements to the library. Nothing major (yet?)

@apaleyes-bot apaleyes-bot force-pushed the add-epmgp-docstrings branch from 406a4f0 to 098b83d Compare May 25, 2026 00:30
- Added detailed Google-style docstrings to min_factor()
- Added comprehensive docstrings to lt_factor()
- Added complete docstrings to log_relative_gauss()

All functions now have full parameter documentation, return/yield
value descriptions, and type hints.

Co-authored-by: Andrei Paleyes <2852301+apaleyes@users.noreply.github.com>
@apaleyes-bot apaleyes-bot force-pushed the add-epmgp-docstrings branch from 098b83d to 01c9498 Compare May 25, 2026 00:33
@mmahsereci
Copy link
Copy Markdown
Contributor

@mmahsereci am playing with agents. Before merging stuff like that wanted to check you are OK with it. All good? If you have any doubts let's discuss.

My plan here is to use an agent to close a bunch of long-standing issues and make some small improvements to the library. Nothing major (yet?)

hey @apaleyes , yeah, all for making our lives easier. I opened a draft PR a while ago for an AGENTS.md file. Could you also have a look here please #484 (comment)
Seeing this PR, it seems the AGENTS.md file could use some guideline on how to write docstrings (eg correct style, adding shapes etc).

@apaleyes apaleyes merged commit 0bdfa7b into EmuKit:main May 25, 2026
9 checks passed
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.

clean up epmgp.py

3 participants