emdgroup / baybe

Bayesian Optimization and Design of Experiments
https://emdgroup.github.io/baybe/
Apache License 2.0
262 stars 42 forks source link

Minor visual issues in the documentation #195

Open AVHopp opened 6 months ago

AVHopp commented 6 months ago

This issue is intended to serve as a place where minor visual issues regarding the documentation can be collected. Once enough such have been identified, they will be resolved in a corresponding PR.

Note in particular that this issue should not be used to collect major changes. Basically, if you see something in our documentation and think "Huh, that just looks a bit weird and would benefit from reformatting", then this is the place to just put it 😄

EDIT: The following issues have been identified:

The following issues have already been fixed:

Scienfitz commented 6 months ago

This kind of formatting issue happns ons everal example pages, here for desirability: image

Scienfitz commented 6 months ago

In general, getting rid of progress bar outputs or at least just having one line (to show the user that somethign WAS computing) would be nice. The caching outputs should go alltogether.

Here in addition we have weird formatting jumps too: image

AVHopp commented 6 months ago

@Scienfitz the tqdm progress bars are already gone, which bars are you referring to?

Scienfitz commented 6 months ago

@AVHopp thats right I thought I still saw progress bars somewhere but it seems theyre gone and I probably confused some of the cache notifications with them

Scienfitz commented 6 months ago

This table in the searchspace userguide looks badly formatted in light mode: image simply fixed by removing the code formatting in table headers

brandon-holt commented 6 months ago

@Scienfitz the tqdm progress bars are already gone, which bars are you referring to?

Would definitely be nice to have some indication of how far along the search is though!

Curious why this was removed?

Scienfitz commented 6 months ago

@brandon-holt this Issue is just about the documentation, where progress bars have been removed. The progress bars when using our simulation module should still be there

brandon-holt commented 6 months ago

@Scienfitz In the Simulation section, the section for simulate_experiment contains a codeblock for simulate scenarios: https://emdgroup.github.io/baybe/userguide/simulation.html

Also, the codeblocks used don't make certain aspects of usage clear. For example, for the campaign variable, do we need to define a searchspace, or will the searchspace be automatically generated from initial_data?

Or, if we use the DataFrame option for the lookup variable, is that not the same dataframe as for initial_data?

Scienfitz commented 6 months ago

@brandon-holt thanks for spotting that! technically your points are not visual but about a bug and content suggestions, so we should not discuss these in this thread.

Would you be open to make s small PR fixing the code snippet? The respective .md file is in docs/userguide/simulation.md . You could also propose text changes that make clearer what you seek.

As for the searchspace question: Nothing is inferred from initial_data, is there anything specific that gave you that impression?

brandon-holt commented 6 months ago

@Scienfitz Just made the PR!

Also, disregard my question about searchspace/initial_data I understand now!

AdrianSosic commented 6 months ago

deprecated strategies namespaces needs to be put on the blacklist

image
AdrianSosic commented 6 months ago

Toc depth of 2 is fine for the examples, but the user guide should have one level less

image
AdrianSosic commented 5 months ago

This is what the readme page on Github looks like in dark mode

image
Scienfitz commented 4 months ago

autodoc page badly cutoff to the right: image

Scienfitz commented 3 months ago

building the doc now has ugly warnigns all over covering the progress bars in case examples are built image

AdrianSosic commented 3 months ago

The "baybe" item in the sidebar should be replaced with a better name at some point. See also: https://github.com/emdgroup/baybe/pull/329#discussion_r1699504607

AVHopp commented 1 month ago

Since the question came up in #347 : Some of the errors mentioned here are fixed in #347 , some things I do not know how to fix (like changing the name of baybe in the TOC, I already tried that several times). Regarding the other things here: Depending on the urgency, I can take care of these in an upcoming PR and then close this issue and we start another one once we accumulate more stuff. What is your opinion here?