publish ml client to maven

client/build.gradle

@@ -6,9 +6,11 @@
 plugins {
     id 'java'
     id "io.freefair.lombok"
-    id 'maven-publish'
     id 'jacoco'
     id 'com.github.johnrengelman.shadow'
+    id 'maven'
+    id 'maven-publish'
+    id 'signing'
 }
 
 dependencies {
@@ -50,20 +52,39 @@ shadowJar {
     archiveClassifier.set(null)
 }
 
+task sourcesJar(type: Jar) {
+    archiveClassifier.set 'sources'
+    from sourceSets.main.allJava
+}
+
+task javadocJar(type: Jar) {
+    archiveClassifier.set 'javadoc'
+    from javadoc.destinationDir
+    dependsOn javadoc
+}
+
 publishing {
+    repositories {
+        maven {
+            name = 'staging'
+            url = "${rootProject.buildDir}/local-staging-repo"
+        }
+    }
     publications {
-        shadow(MavenPublication) {
-            project.shadow.component(it)
+        shadow(MavenPublication) { publication ->
+            project.shadow.component(publication)
+            artifact sourcesJar
+            artifact javadocJar
 
             pom {
-                name = "OpenSearch Machine Learning Client Library"
+                name = "OpenSearch Machine Learning Client"
                 packaging = "jar"
-                url = "https://github.com/opensearch-project/machine-learning"
-                description = "OpenSearch Machine Learning Client Library"
+                url = "https://github.com/opensearch-project/ml-commons"
+                description = "OpenSearch Machine Learning Client"
                 scm {
-                    connection = "scm:git@github.com:opensearch-project/machine-learning.git"
-                    developerConnection = "scm:git@github.com:opensearch-project/machine-learning.git"
-                    url = "git@github.com:opensearch-project/machine-learning.git"
+                    connection = "scm:git@github.com:opensearch-project/ml-commons.git"
+                    developerConnection = "scm:git@github.com:opensearch-project/ml-commons.git"
+                    url = "git@github.com:opensearch-project/ml-commons.git"
                 }
                 licenses {
                     license {
@@ -73,14 +94,13 @@ publishing {
                 }
                 developers {
                     developer {
-                        id = "amazonwebservices"
-                        organization = "Amazon Web Services"
-                        organizationUrl = "https://aws.amazon.com"
+                        name = "OpenSearch"
+                        url = "https://github.com/opensearch-project/ml-commons"
                     }
                 }
             }
         }
     }
 
-
 }
+

client/src/main/java/org/opensearch/ml/client/MachineLearningClient.java

@@ -27,7 +27,7 @@ public interface MachineLearningClient {
      * Do prediction machine learning job
      * @param modelId the trained model id
      * @param mlInput ML input
-     * @return
+     * @return ActionFuture of MLOutput
      */
     default ActionFuture<MLOutput> predict(String modelId, MLInput mlInput) {
         PlainActionFuture<MLOutput> actionFuture = PlainActionFuture.newFuture();
@@ -64,7 +64,8 @@ default ActionFuture<MLOutput> trainAndPredict(MLInput mlInput) {
     /**
      *  Do the training machine learning job. The training job will be always async process. The job id will be returned in this method.
      * @param mlInput ML input
-     * @return the result future
+     * @param asyncTask is async task or not
+     * @return ActionFuture of MLOutput
      */
     default ActionFuture<MLOutput> train(MLInput mlInput, boolean asyncTask) {
         PlainActionFuture<MLOutput> actionFuture = PlainActionFuture.newFuture();
@@ -76,6 +77,7 @@ default ActionFuture<MLOutput> train(MLInput mlInput, boolean asyncTask) {
     /**
      * Do the training machine learning job. The training job will be always async process. The job id will be returned in this method.
      * @param mlInput ML input
+     * @param asyncTask is async task or not
      * @param listener a listener to be notified of the result
      */
     void train(MLInput mlInput, boolean asyncTask, ActionListener<MLOutput> listener);

scripts/build.sh

@@ -0,0 +1,73 @@
+#!/bin/bash
+
+#
+# Copyright OpenSearch Contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+
+set -ex
+
+function usage() {
+    echo "Usage: $0 [args]"
+    echo ""
+    echo "Arguments:"
+    echo -e "-v VERSION\t[Required] OpenSearch version."
+    echo -e "-s SNAPSHOT\t[Optional] Build a snapshot, default is 'false'."
+    echo -e "-p PLATFORM\t[Optional] Platform, ignored."
+    echo -e "-a ARCHITECTURE\t[Optional] Build architecture, ignored."
+    echo -e "-o OUTPUT\t[Optional] Output path, default is 'artifacts'."
+    echo -e "-h help"
+}
+
+while getopts ":h:v:s:o:p:a:" arg; do
+    case $arg in
+        h)
+            usage
+            exit 1
+            ;;
+        v)
+            VERSION=$OPTARG
+            ;;
+        s)
+            SNAPSHOT=$OPTARG
+            ;;
+        o)
+            OUTPUT=$OPTARG
+            ;;
+        p)
+            PLATFORM=$OPTARG
+            ;;
+        a)
+            ARCHITECTURE=$OPTARG
+            ;;
+        :)
+            echo "Error: -${OPTARG} requires an argument"
+            usage
+            exit 1
+            ;;
+        ?)
+            echo "Invalid option: -${arg}"
+            exit 1
+            ;;
+    esac
+done
+
+if [ -z "$VERSION" ]; then
+    echo "Error: You must specify the OpenSearch version"
+    usage
+    exit 1
+fi
+
+[[ "$SNAPSHOT" == "true" ]] && VERSION=$VERSION-SNAPSHOT
+[ -z "$OUTPUT" ] && OUTPUT=artifacts
+
+./gradlew publishToMavenLocal -Dopensearch.version=$VERSION -Dbuild.snapshot=$SNAPSHOT
+./gradlew publishAllPublicationsToStagingRepository -Dopensearch.version=$VERSION -Dbuild.snapshot=$SNAPSHOT
+mkdir -p $OUTPUT/maven/org/opensearch
+cp -r ./build/local-staging-repo/org/opensearch/ml/. $OUTPUT/maven/org/opensearch
+
+./gradlew assemble --no-daemon --refresh-dependencies -DskipTests=true -Dopensearch.version=$VERSION -Dbuild.snapshot=$SNAPSHOT
+[ -z "$OUTPUT" ] && OUTPUT=artifacts
+mkdir -p $OUTPUT/plugins
+cp ./plugin/build/distributions/*.zip $OUTPUT/plugins