From f7573b28d80da4520c8aad0d77a3fc5aee457fb8 Mon Sep 17 00:00:00 2001 From: Jeff Ching Date: Wed, 22 Jan 2020 07:04:47 -0800 Subject: [PATCH] feat: promote to GA (#86) Release-As: 1.0.0 --- .repo-metadata.json | 2 +- README.md | 86 ++++++++++++++++++++++++--------------------- 2 files changed, 47 insertions(+), 41 deletions(-) diff --git a/.repo-metadata.json b/.repo-metadata.json index 3f0868cad..23ba3be94 100644 --- a/.repo-metadata.json +++ b/.repo-metadata.json @@ -4,7 +4,7 @@ "product_documentation": "https://cloud.google.com/automl/docs/", "client_documentation": "https://googleapis.dev/java/java-automl/latest/index.html", "issue_tracker": "https://issuetracker.google.com/savedsearches/559744", - "release_level": "beta", + "release_level": "ga", "language": "java", "repo": "googleapis/java-automl", "repo_short": "java-automl", diff --git a/README.md b/README.md index eef4a032d..b0e44facb 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Google Cloud Java Client for Cloud Auto ML +# Google Cloud Auto ML Client for Java -Java idiomatic client for [Cloud Auto ML][api-reference]. +Java idiomatic client for [Cloud Auto ML][product-docs]. [![Maven][maven-version-image]][maven-version-link] ![Stability][stability-image] @@ -8,31 +8,34 @@ Java idiomatic client for [Cloud Auto ML][api-reference]. - [Product Documentation][product-docs] - [Client Library Documentation][javadocs] -> Note: This client is a work-in-progress, and may occasionally -> make backwards-incompatible changes. - ## Quickstart -If you are using Maven with a BOM, add this to your pom.xml file. + +If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file ```xml - - - com.google.cloud - libraries-bom - 3.2.0 - pom - import - - + + + com.google.cloud + libraries-bom + 3.4.0 + pom + import + + - - com.google.cloud - google-cloud-automl - + + + com.google.cloud + google-cloud-automl + + ``` + [//]: # ({x-version-update-start:google-cloud-automl:released}) -If you are using Maven without a BOM, add this to your dependencies. + +If you are using Maven without BOM, add this to your dependencies: + ```xml com.google.cloud @@ -40,6 +43,7 @@ If you are using Maven without a BOM, add this to your dependencies. 0.115.2-beta ``` + If you are using Gradle, add this to your dependencies ```Groovy compile 'com.google.cloud:google-cloud-automl:0.115.2-beta' @@ -54,20 +58,13 @@ libraryDependencies += "com.google.cloud" % "google-cloud-automl" % "0.115.2-bet See the [Authentication][authentication] section in the base directory's README. -## About Cloud Auto ML - -[Cloud Auto ML][api-reference] is a suite of Machine Learning products. - -See the [Cloud Auto ML client library docs][javadocs] to learn how to -use this Cloud Auto ML Client Library. - ## Getting Started ### Prerequisites -You will need a [Google Developers Console][developer-console] project with the -Cloud Auto ML API enabled. [Follow these instructions][create-project] to get your -project set up. You will also need to set up the local development environment by +You will need a [Google Cloud Platform Console][developer-console] project with the Cloud Auto ML [API enabled][enable-api]. + +[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by [installing the Google Cloud SDK][cloud-sdk] and running the following commands in command line: `gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`. @@ -76,13 +73,20 @@ project set up. You will also need to set up the local development environment b You'll need to obtain the `google-cloud-automl` library. See the [Quickstart](#quickstart) section to add `google-cloud-automl` as a dependency in your code. -## Troubleshooting +## About Cloud Auto ML + + +[Cloud Auto ML][product-docs] + +See the [Cloud Auto ML client library docs][javadocs] to learn how to +use this Cloud Auto ML Client Library. -To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting]. -## Transport -Cloud Auto ML uses gRPC for the transport layer. + +## Troubleshooting + +To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting]. ## Java Versions @@ -92,14 +96,14 @@ Java 7 or above is required for using this client. This library follows [Semantic Versioning](http://semver.org/). -It is currently in major version zero (``0.y.z``), which means that anything may change at any time -and the public API should not be considered stable. + ## Contributing + Contributions to this library are always welcome and highly encouraged. -See [CONTRIBUTING.md][contributing] documentation for more information on how to get started. +See [CONTRIBUTING][contributing] for more information how to get started. Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more @@ -119,9 +123,8 @@ Java 8 OSX | [![Kokoro CI][kokoro-badge-image-3]][kokoro-badge-link-3] Java 8 Windows | [![Kokoro CI][kokoro-badge-image-4]][kokoro-badge-link-4] Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5] -[api-reference]: https://cloud.google.com/automl/ [product-docs]: https://cloud.google.com/automl/docs/ -[javadocs]: https://googleapis.dev/java/google-cloud-automl/latest/index.html +[javadocs]: https://googleapis.dev/java/java-automl/latest/index.html [kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-automl/java7.svg [kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-automl/java7.html [kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-automl/java8.svg @@ -132,7 +135,7 @@ Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5] [kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-automl/java8-win.html [kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-automl/java11.svg [kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-automl/java11.html -[stability-image]: https://img.shields.io/badge/stability-beta-yellow +[stability-image]: https://img.shields.io/badge/stability-ga-green [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-automl.svg [maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-automl&core=gav [authentication]: https://github.com/googleapis/google-cloud-java#authentication @@ -143,3 +146,6 @@ Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5] [contributing]: https://github.com/googleapis/java-automl/blob/master/CONTRIBUTING.md [code-of-conduct]: https://github.com/googleapis/java-automl/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct [license]: https://github.com/googleapis/java-automl/blob/master/LICENSE + +[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=automl.googleapis.com +[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM \ No newline at end of file