Skip to content
This repository has been archived by the owner on Sep 16, 2023. It is now read-only.

docs: add stability image #10

Merged
merged 4 commits into from Sep 30, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .repo-metadata.json
@@ -1,6 +1,6 @@
{
"name": "automl",
"name_pretty": "AutoML",
"name_pretty": "Cloud Auto ML",
"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",
Expand Down
132 changes: 80 additions & 52 deletions README.md
@@ -1,21 +1,19 @@
Google Cloud Java Client for Cloud Auto ML
===================================================
# Google Cloud Java Client for Cloud Auto ML

Java idiomatic client for [Cloud Auto ML][cloud-automl].
Java idiomatic client for [Cloud Auto ML][api-reference].

[![Kokoro CI](http://storage.googleapis.com/cloud-devrel-public/java/badges/java-automl/master.svg)](http://storage.googleapis.com/cloud-devrel-public/java/badges/java-automl/master.html)
[![Maven](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-automl.svg)](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-automl.svg)
[![Maven][maven-version-image]][maven-version-link]
![Stability][stability-image]

- [Product Documentation][automl-product-docs]
- [Client Library Documentation][automl-client-lib-docs]
- [Product Documentation][product-docs]
- [Client Library Documentation][javadocs]

> Note: This client is a work-in-progress, and may occasionally
> make backwards-incompatible changes.

Quickstart
----------
## Quickstart

[//]: # ({x-version-update-start:google-cloud-automl:released})
[//]: # ({x-version-update-start:automl:released})
If you are using Maven, add this to your pom.xml file
```xml
<dependency>
Expand All @@ -34,66 +32,96 @@ libraryDependencies += "com.google.cloud" % "google-cloud-automl" % "0.111.0-bet
```
[//]: # ({x-version-update-end})

Authentication
--------------
## Authentication

See the [Authentication](https://github.com/googleapis/google-cloud-java#authentication) section in the base directory's README.
See the [Authentication][authentication] section in the base directory's README.

About Cloud Auto ML
----------------------------
## About Cloud Auto ML

[Cloud Auto ML][cloud-automl] is a suite of Machine Learning products.
[Cloud Auto ML][api-reference] is a suite of Machine Learning products.

See the [Cloud Auto ML client library docs][automl-client-lib-docs] to learn how to use this Cloud Auto ML Client Library.
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](https://console.developers.google.com/) project with the Cloud Auto ML API enabled. [Follow these instructions](https://cloud.google.com/resource-manager/docs/creating-managing-projects) to get your project set up. You will also need to set up the local development environment by [installing the Google Cloud SDK](https://cloud.google.com/sdk/) and running the following commands in command line: `gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.
## Getting Started

#### Installation and setup
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.
### Prerequisites

Troubleshooting
---------------
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
[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]`.

To get help, follow the instructions in the [shared Troubleshooting document](https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting).
### Installation and setup

Transport
---------
Cloud Auto ML uses gRPC for the transport layer.
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.

Java Versions
-------------
## Troubleshooting

Java 7 or above is required for using this client.
To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].

Versioning
----------
## Transport

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.
Cloud Auto ML uses gRPC for the transport layer.

Contributing
------------
## Java Versions

Contributions to this library are always welcome and highly encouraged.
Java 7 or above is required for using this client.

See `google-cloud`'s [CONTRIBUTING] documentation and the [shared documentation](https://github.com/googleapis/google-cloud-common/blob/master/contributing/readme.md#how-to-contribute-to-gcloud) for more information on how to get started.
## Versioning

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 information.
This library follows [Semantic Versioning](http://semver.org/).

License
-------
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.

Apache 2.0 - See [LICENSE] for more information.
## Contributing

Contributions to this library are always welcome and highly encouraged.

[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
[cloud-platform]: https://cloud.google.com/
[cloud-automl]: https://cloud.google.com/automl
[automl-product-docs]: https://cloud.google.com/automl/
[automl-client-lib-docs]: https://googleapis.dev/java/java-automl/latest/index.html
See [CONTRIBUTING.md][contributing] documentation for more information on 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
information.

## License

Apache 2.0 - See [LICENSE][license] for more information.

## CI Status

Java Version | Status
------------ | ------
Java 7 | [![Kokoro CI][kokoro-badge-image-1]][kokoro-badge-link-1]
Java 8 | [![Kokoro CI][kokoro-badge-image-2]][kokoro-badge-link-2]
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/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
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-automl/java8.html
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-automl/java8-osx.svg
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-automl/java8-osx.html
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-automl/java8-win.svg
[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
[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
[developer-console]: https://console.developers.google.com/
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
[cloud-sdk]: https://cloud.google.com/sdk/
[troubleshooting]: https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting
[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