Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 238C8200BAF for ; Mon, 31 Oct 2016 18:58:37 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 220DB160B06; Mon, 31 Oct 2016 17:58:37 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 6A0F3160B05 for ; Mon, 31 Oct 2016 18:58:36 +0100 (CET) Received: (qmail 68208 invoked by uid 500); 31 Oct 2016 17:58:35 -0000 Mailing-List: contact commits-help@lucene.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@lucene.apache.org Delivered-To: mailing list commits@lucene.apache.org Received: (qmail 68130 invoked by uid 99); 31 Oct 2016 17:58:35 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 31 Oct 2016 17:58:35 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 4E7D9E09B6; Mon, 31 Oct 2016 17:58:35 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: cpoerschke@apache.org To: commits@lucene.apache.org Date: Mon, 31 Oct 2016 17:58:36 -0000 Message-Id: <4d09ec468e7544039edcd84672817447@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [2/2] lucene-solr:jira/solr-8542-v2: SOLR-8542: overview.html proof-read/tweak archived-at: Mon, 31 Oct 2016 17:58:37 -0000 SOLR-8542: overview.html proof-read/tweak Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/e17a3430 Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/e17a3430 Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/e17a3430 Branch: refs/heads/jira/solr-8542-v2 Commit: e17a3430f05cd2072f32bbd42faf93f5150e8533 Parents: 363233d Author: Christine Poerschke Authored: Mon Oct 31 17:55:23 2016 +0000 Committer: Christine Poerschke Committed: Mon Oct 31 17:55:23 2016 +0000 ---------------------------------------------------------------------- solr/contrib/ltr/src/java/overview.html | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/e17a3430/solr/contrib/ltr/src/java/overview.html ---------------------------------------------------------------------- diff --git a/solr/contrib/ltr/src/java/overview.html b/solr/contrib/ltr/src/java/overview.html index 7b8198c..47179f0 100644 --- a/solr/contrib/ltr/src/java/overview.html +++ b/solr/contrib/ltr/src/java/overview.html @@ -29,7 +29,7 @@ functions like TF-IDF or BM25.

This module allows to plug a reranking component directly into Solr, enabling users -lto easily build their own learning to rank systems and access the rich +to easily build their own learning to rank systems and access the rich matching features readily available in Solr. It also provides tools to perform feature engineering and feature extraction.

@@ -37,7 +37,7 @@ feature engineering and feature extraction.

A Learning to Rank model is plugged into the ranking through the {@link org.apache.solr.search.LTRQParserPlugin}, a {@link org.apache.solr.search.QParserPlugin}. The plugin will -read from the request the model (instance of {@link org.apache.solr.ltr.LTRScoringQuery}) +read from the request the model (instance of {@link org.apache.solr.ltr.LTRScoringModel}) used to perform the request plus other parameters. The plugin will generate a {@link org.apache.solr.search.LTRQParserPlugin.LTRQuery LTRQuery}: a particular {@link org.apache.solr.search.RankQuery} @@ -63,7 +63,7 @@ into the framework by extending {@link org.apache.solr.ltr.model.LTRScoringMode The {@link org.apache.solr.ltr.LTRScoringQuery} will take care of computing the values of all the features (see {@link org.apache.solr.ltr.feature.Feature}) and then will delegate the final score generation to the {@link org.apache.solr.ltr.model.LTRScoringModel}, by calling the method -{@link org.apache.solr.ltr.model.LTRScoringModel#score(float[] modelFeatureValuesNormalized) score(float[] modelFeatureValuesNormalized)}. +{@link org.apache.solr.ltr.model.LTRScoringModel#score(float[] modelFeatureValuesNormalized)}.

A {@link org.apache.solr.ltr.feature.Feature} will produce a particular value for each document, so @@ -72,17 +72,17 @@ it is modeled as a {@link org.apache.lucene.search.Query}. The package of features. One benefit of extending the Query object is that we can reuse Query as a feature, see for example {@link org.apache.solr.ltr.feature.SolrFeature}. Features for a document can also be returned in the response by -using {@link org.apache.solr.response.transform.DocTransformer DocTransformer} +using the FeatureTransformer (a {@link org.apache.solr.response.transform.DocTransformer DocTransformer}) provided by {@link org.apache.solr.response.transform.LTRFeatureLoggerTransformerFactory}.

-{@link org.apache.solr.ltr.store} contains all the logic to store all the features and the models -added by a user. Models are registered into a unique {@link org.apache.solr.ltr.store.ModelStore ModelStore}, +{@link org.apache.solr.ltr.store} contains all the logic to store all the features and the models. +Models are registered into a unique {@link org.apache.solr.ltr.store.ModelStore ModelStore}, and each model specifies a particular {@link org.apache.solr.ltr.store.FeatureStore FeatureStore} that will contain a particular subset of features.

-A user can manage features and models through a REST API, provided by the +Features and models can be managed through a REST API, provided by the {@link org.apache.solr.rest.ManagedResource Managed Resources} {@link org.apache.solr.ltr.store.rest.ManagedFeatureStore ManagedFeatureStore} and {@link org.apache.solr.ltr.store.rest.ManagedModelStore ManagedModelStore}.