botorch icon indicating copy to clipboard operation
botorch copied to clipboard

[Documentation] Inaccurate and incomplete documentation for `SingleTaskMultiFidelityGP`

Open esantorella opened this issue 1 year ago • 2 comments

  • The docstring for linear_truncated and the class docstring describe what the behavior would be if the default were linear_truncated=False. However, the default is True. The model uses a LinearTruncatedFidelityKernel, which isn't described at all.
  • It is not clear how data fidelities are to be interpreted. Does a higher number indicate higher fidelity? Can they lie outside [0, 1]? Do they have a cardinal or ordinal interpretation?

This came up in #2393 , and I spent a while myself trying to understand how fidelities should be specified and how they affect the kernel.

esantorella avatar Jun 29 '24 17:06 esantorella

Hi @esantorella !

Could you please assign this issue to me ? I'd like to work on this .

Thank You !

Muhammad-Rebaal avatar May 11 '25 08:05 Muhammad-Rebaal

@Muhammad-Rebaal Done, thank you!

esantorella avatar May 11 '25 12:05 esantorella