From 6352ce35440b7e41716e1ec3e9c97347a602f9d1 Mon Sep 17 00:00:00 2001 From: Scott Ivey Date: Mon, 12 Oct 2015 23:36:11 -0400 Subject: [PATCH] documentation updates --- docs/clients/{java.md => jvm.md} | 9 +++++++-- docs/clients/ruby.md | 2 ++ mkdocs.yml | 2 +- 3 files changed, 10 insertions(+), 3 deletions(-) rename docs/clients/{java.md => jvm.md} (82%) diff --git a/docs/clients/java.md b/docs/clients/jvm.md similarity index 82% rename from docs/clients/java.md rename to docs/clients/jvm.md index 1f6c880..3b9b9cf 100644 --- a/docs/clients/java.md +++ b/docs/clients/jvm.md @@ -1,8 +1,8 @@ -# Java Client +# JVM Clients ## Installation -The Java client is available from Sonatype OSS. +Relevanced has a Java client which can also be used from any other JVM language. It's hosted on Sonatype OSS. To add it to a Maven project, add the following dependency to your `pom.xml` file: ```xml @@ -56,3 +56,8 @@ public class Main { } } ``` + + +Also see the Java [binary classifier](../examples/java-binary-classifier.md) and [multi-class classifier](../examples/java-multiclass-classifier.md) examples for more practical use. + +There is also a [Scala version](../examples/scala-binary-classifier.md) of the binary classifier example. diff --git a/docs/clients/ruby.md b/docs/clients/ruby.md index f4f1b1b..f4af520 100644 --- a/docs/clients/ruby.md +++ b/docs/clients/ruby.md @@ -33,3 +33,5 @@ some_score = client.get_document_similarity( ) ``` + +Also see the Ruby [binary classifier](../examples/ruby-binary-classifier.md) example for more practical use. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 4c840e8..d5b91da 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -26,5 +26,5 @@ pages: - Javascript: clients/javascript.md - Python: clients/python.md - Ruby: clients/ruby.md - - Java: clients/java.md + - JVM: clients/jvm.md