Daniel Kinzler has submitted this change and it was merged.

Change subject: Added doc comments for the Rescorer and console-based entity 
suggester classes
......................................................................


Added doc comments for the Rescorer and console-based entity suggester classes

Change-Id: I080c572dad3049c90636bf9da5e8d7d7e0010ed0
---
M 
client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/CLIEntitySuggester.java
M 
rescorer/src/main/java/org/wikimedia/wikibase/entitysuggester/rescorer/EntityRescorerProvider.java
M 
rescorer/src/main/java/org/wikimedia/wikibase/entitysuggester/rescorer/ItemListRetriever.java
3 files changed, 13 insertions(+), 0 deletions(-)

Approvals:
  Daniel Kinzler: Verified; Looks good to me, approved



diff --git 
a/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/CLIEntitySuggester.java
 
b/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/CLIEntitySuggester.java
index 8fd04a1..5407c4f 100644
--- 
a/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/CLIEntitySuggester.java
+++ 
b/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/CLIEntitySuggester.java
@@ -9,6 +9,8 @@
 import 
org.wikimedia.wikibase.entitysuggester.client.recommender.CLIClientRecommender;
 
 /**
+ * The command line parser/driver for using the suggester from the console.
+ * Mainly used for debugging purposes.
  *
  * @author Nilesh Chakraborty
  */
diff --git 
a/rescorer/src/main/java/org/wikimedia/wikibase/entitysuggester/rescorer/EntityRescorerProvider.java
 
b/rescorer/src/main/java/org/wikimedia/wikibase/entitysuggester/rescorer/EntityRescorerProvider.java
index 5b999e7..2b71223 100644
--- 
a/rescorer/src/main/java/org/wikimedia/wikibase/entitysuggester/rescorer/EntityRescorerProvider.java
+++ 
b/rescorer/src/main/java/org/wikimedia/wikibase/entitysuggester/rescorer/EntityRescorerProvider.java
@@ -13,6 +13,12 @@
 import org.apache.mahout.cf.taste.recommender.IDRescorer;
 
 /**
+ * Rescorer factory to use with Myrrix to support suggestion of both
+ * wikibaseProperties and wikibaseValues.
+ *
+ * This may be removed or refactored heavily shortly if I remove wikibaseValue
+ * suggestion from this part of the suggester.
+ *
  * @author Nilesh Chakraborty
  */
 public class EntityRescorerProvider extends AbstractRescorerProvider {
diff --git 
a/rescorer/src/main/java/org/wikimedia/wikibase/entitysuggester/rescorer/ItemListRetriever.java
 
b/rescorer/src/main/java/org/wikimedia/wikibase/entitysuggester/rescorer/ItemListRetriever.java
index fd850fe..2f5deab 100644
--- 
a/rescorer/src/main/java/org/wikimedia/wikibase/entitysuggester/rescorer/ItemListRetriever.java
+++ 
b/rescorer/src/main/java/org/wikimedia/wikibase/entitysuggester/rescorer/ItemListRetriever.java
@@ -7,6 +7,11 @@
 import org.apache.mahout.common.iterator.FileLineIterable;
 
 /**
+ * Used with EntityRescorerProvider to initialize an IDMigrator instance and 
use
+ * it to translate wikibaseProperty or wikibaseValue IDs.
+ *
+ * This may be removed or refactored heavily shortly if I remove wikibaseValue
+ * suggestion from this part of the suggester.
  *
  * @author Nilesh Chakraborty
  */

-- 
To view, visit https://gerrit.wikimedia.org/r/75488
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: I080c572dad3049c90636bf9da5e8d7d7e0010ed0
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/WikidataEntitySuggester
Gerrit-Branch: master
Gerrit-Owner: Nilesh <nil...@nileshc.com>
Gerrit-Reviewer: Daniel Kinzler <daniel.kinz...@wikimedia.de>

_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

Reply via email to