ctargett commented on a change in pull request #476:
URL: https://github.com/apache/solr/pull/476#discussion_r787795388
##########
File path: solr/solr-ref-guide/src/neural-search.adoc
##########
@@ -0,0 +1,733 @@
+= Neural Search
Review comment:
I put this in Slack, here's my take on it:
I have no objection to calling our dense vector support a neural search
feature. To be clear, my objection is naming the entire page neural search when
there is only one feature described and no indication whatsoever what other
features might be or when they may arrive. Seriously, I didn’t see one thing on
that page that’s about anything other than dense vectors.
Of course it’s all right that Solr does not have several neural search
features right now. Just as it’s all right we don’t yet have any number of
other features. To use a parallel example, LTR is a machine learning feature,
but we did not name the page “Machine Learning”; we named the page for exactly
the feature. It doesn’t knock against LTR that the page isn’t titled “Machine
Learning” nor diminish its significance as a feature.
The Ref Guide is not a marketing document - write a news item or a page in
the website to promote this functionality when it is released. Call it “Neural
Search Comes to Solr” if you want (and you should!). But the Ref Guide must be
clear and direct. It is meant for our users to know *exactly* what they need to
do to configure Solr to take advantage of the features. I recently renamed
dozens of pages and the guiding principle was to make them named for the exact
functionality described on the page to make it clear to readers before they
even click the title what they can expect to find there.
SolrCloud and Neural Search can be analogous, as large concepts that have
several features. But dense vectors is a single feature. When there is more
than one, we can talk about an overarching section that brings all the features
together but we aren’t there yet at all.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org
For additional commands, e-mail: issues-h...@solr.apache.org
