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

Trouble with searching documentation (Algolia, API docs, etc.), for example get_next_trials #2264

Closed
sgbaird opened this issue Mar 11, 2024 · 1 comment
Assignees

Comments

@sgbaird
Copy link
Contributor

sgbaird commented Mar 11, 2024

@jwatchorn brought up an issue with the Algolia search from the docs, some links with the tutorials, and the API docs. For example, when trying to find more info on ax_client.get_next_trials, an Algolia search only seems to pull up references to get_next_trial rather than get_next_trials:

image

Going to a direct API search, the interface hangs and I don't see any results actually come up:

image

Taking a look at one of the previous hits for get_next_trial (instead of get_next_trials):

image

The link to get_next_trial doesn't have get_next_trial anywhere or the AxClient class even.

image

image

Some workarounds/alternatives of course are searching issues, discussions, and the codebase directly. Likewise, hovering over items to reveal docstrings in an IDE.

ccardoso-colada added a commit to ccardoso-colada/Ax that referenced this issue Mar 13, 2024
Cesar-Cardoso added a commit that referenced this issue Mar 13, 2024
facebook-github-bot pushed a commit that referenced this issue Mar 13, 2024
Summary:
See #2264


Reviewed By: Balandat

Differential Revision: D54833604

Pulled By: Cesar-Cardoso
@Cesar-Cardoso Cesar-Cardoso self-assigned this Mar 13, 2024
facebook-github-bot pushed a commit that referenced this issue Mar 13, 2024
Summary:
See #2264

Pull Request resolved: #2267

Reviewed By: Balandat

Differential Revision: D54833604

Pulled By: Cesar-Cardoso

fbshipit-source-id: a2a2ca148ec4defaa1eb42e6d1cb10cd535a9e20
@Cesar-Cardoso
Copy link
Contributor

Thanks for flagging this! It's been fixed in #2267. The issue should be resolved in the next release of the website.

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

No branches or pull requests

2 participants