Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Replace Google search by Algolia docsearch #6710

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

Closed
wants to merge 1 commit into from
Closed

Replace Google search by Algolia docsearch #6710

wants to merge 1 commit into from

Conversation

LeoErcolanelli
Copy link

Hello scikit-learn team!

I have been using scikit-learn lately and I struggled sometimes finding efficiently what I was looking for; this is what I try to improve with this pull request.

scikit4

You can test it live here. Note that each search will redirect to scikit-learn.org.

Benefits for the end user

  • Search in the whole documentation with typo tolerance
  • Instant access to the documentation at the first keystroke, in a few milliseconds

How it works

  1. We periodically crawl your documentation pages so you are always up to date.
  2. You don’t need to configure any settings or even have an Algolia account.
    We take care of all of this automatically to ensure the best documentation search experience.
  3. It's free: no commitment, no subscription, and it won't change.

Relevant links

About Algolia

At Algolia we provide a hosted search API and support community websites via initiatives like Docsearch or community plans.

I'm available for any question you may have or any more information you would need.

@GaelVaroquaux
Copy link
Member

GaelVaroquaux commented Apr 25, 2016 via email

@LeoErcolanelli
Copy link
Author

Even though my view may indeed be biased, this pull request is still relevant in my opinion:

  • I don't deny that Google Custom Search is a great tool but it is more focused on searching for web pages. The way Docsearch works is by indexing hierarchically your documentation: it's thus more faithful to its structure
  • The UX provided by Google Custom Search is not the best one available, and as-you-type search is somehow nicer to use than an intermediate page showing the results
  • Algolia indeed has less tried and tested products than Google, but a lot of efforts have been put in Docsearch and it is already live in several "big" open source projects: https://facebook.github.io/react/, http://docs.scala-lang.org/, https://babeljs.algolia.com/, etc.

(I am here only talking about the search within the documentation provided by Google Custom Search and in no way about the search http://www.google.com is able to deliver)

@TomDLT
Copy link
Member

TomDLT commented Apr 25, 2016

Not convinced:
model selection => does not show the chapter 3 of the user guide ("Model selection and evaluation")
BaseEstimator => no relevant results
projected gradient nmf => no relevant results
check_x_y => no relevant results
Fabian Pedregosa => no results

For each of these examples, the first link in Google Custom Search is very relevant.

@LeoErcolanelli
Copy link
Author

LeoErcolanelli commented Apr 25, 2016

Hi @TomDLT !

The url targeted (or excluded) by the scraper are configurable. I indeed excluded the "summary" pages, but I can add them as well as the "about" pages. May I change the configuration so can you give it another try?

@jnothman
Copy link
Member

We rarely accept a PR without demanding changes; sure, tweak it. We absolutely need API reference included, and it does not seem to be there.

@jnothman
Copy link
Member

jnothman commented Apr 25, 2016

Are those changes made in our HTML/JS invocation, or in an API client configuration interface?

@LeoErcolanelli
Copy link
Author

The changes I am currently making are done to a JSON configuration file used by our crawler.
The JSON file in itself is public and can be found here: https://github.com/algolia/docsearch-configs/blob/master/sklearn.json
The crawler actually using this file is not public however

@LeoErcolanelli
Copy link
Author

The configuration has been updated and the demo is up to date here
Tell me what you think!

@TomDLT
Copy link
Member

TomDLT commented Apr 25, 2016

Thanks for the update, this is better.
However I personally don't like that:

  • If I choose a wrong link and go back to previous page, I have to type again the search.
  • In the same way, I can't open several pages in several tabs from one unique search.

@jnothman
Copy link
Member

Also:

  • perhaps our documentation isn't as well-structured as it could be - or as hierarchical as Algolia insists it should be - but most queries I type give the same heading and page name, i.e. the title is triplicated in the search results UI
  • entering classifier in Google gives me the example "Classifier comparison" as the top result, and narrative "Supervised learning" next, better than all top-5 results returned by Algolia.

I am closing this this PR as "not yet", to let Algolia improve UI, ranking, handling of less-structured documentations, etc.

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.

4 participants