Skip to content

Commit

Permalink
docs: Update io.proto to use markdown headings instead of HTML, remov…
Browse files Browse the repository at this point in the history 
…e some unused HTML from markdown (#5866)

* docs: Update io.proto to use markdown headings instead of HTML, remove some unused HTML from markdown

PiperOrigin-RevId: 703192272

Source-Link: googleapis/googleapis@05347e0

Source-Link: googleapis/googleapis-gen@71b9549
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWF1dG9tbC8uT3dsQm90LnlhbWwiLCJoIjoiNzFiOTU0OTVkNmZiMjlkOTcwZWFkNmExNzc1MmQ1OGQxZWZjOGZmYiJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
@gcf-owl-bot
gcf-owl-bot[bot] and gcf-owl-bot[bot] authored Dec 9, 2024
1 parent 522c389 commit 62687be
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 51 deletions.
4 changes: 2 additions & 2 deletions packages/google-cloud-automl/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
1. [Select or create a Cloud Platform project][projects].
1. [Enable billing for your project][billing].
1. [Enable the Cloud AutoML API][enable_api].
1. [Set up authentication with a service account][auth] so you can access the
1. [Set up authentication][auth] so you can access the
API from your local workstation.

### Installing the client library
Expand Down Expand Up @@ -250,4 +250,4 @@ See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)
[projects]: https://console.cloud.google.com/project
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=automl.googleapis.com
[auth]: https://cloud.google.com/docs/authentication/getting-started
[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local
86 changes: 37 additions & 49 deletions packages/google-cloud-automl/protos/google/cloud/automl/v1/io.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ option java_package = "com.google.cloud.automl.v1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1";
option ruby_package = "Google::Cloud::AutoML::V1";

// Input configuration for [AutoMl.ImportData][google.cloud.automl.v1.AutoMl.ImportData] action.
// Input configuration for
// [AutoMl.ImportData][google.cloud.automl.v1.AutoMl.ImportData] action.
//
// The format of input depends on dataset_metadata the Dataset into which
// the import is happening has. As input source the
Expand All @@ -41,10 +42,10 @@ option ruby_package = "Google::Cloud::AutoML::V1";
// The formats are represented in EBNF with commas being literal and with
// non-terminal symbols defined near the end of this comment. The formats are:
//
// <h4>AutoML Vision</h4>
// #### AutoML Vision
//
//
// <div class="ds-selector-tabs"><section><h5>Classification</h5>
// ##### Classification
//
// See [Preparing your training
// data](https://cloud.google.com/vision/automl/docs/prepare) for more
Expand Down Expand Up @@ -81,7 +82,7 @@ option ruby_package = "Google::Cloud::AutoML::V1";
// UNASSIGNED,gs://folder/image4.jpg
//
//
// </section><section><h5>Object Detection</h5>
// ##### Object Detection
// See [Preparing your training
// data](https://cloud.google.com/vision/automl/object-detection/docs/prepare)
// for more information.
Expand Down Expand Up @@ -123,10 +124,10 @@ option ruby_package = "Google::Cloud::AutoML::V1";
// </div>
//
//
// <h4>AutoML Video Intelligence</h4>
// #### AutoML Video Intelligence
//
//
// <div class="ds-selector-tabs"><section><h5>Classification</h5>
// ##### Classification
//
// See [Preparing your training
// data](https://cloud.google.com/video-intelligence/automl/docs/prepare) for
Expand Down Expand Up @@ -169,7 +170,7 @@ option ruby_package = "Google::Cloud::AutoML::V1";
//
//
//
// </section><section><h5>Object Tracking</h5>
// ##### Object Tracking
//
// See [Preparing your training
// data](/video-intelligence/automl/object-tracking/docs/prepare) for more
Expand Down Expand Up @@ -220,14 +221,12 @@ option ruby_package = "Google::Cloud::AutoML::V1";
// gs://folder/video1.avi,bike,,12.50,.45,.45,,,.55,.55,,
// gs://folder/video2.avi,car,1,0,.1,.9,,,.9,.1,,
// gs://folder/video2.avi,,,,,,,,,,,
// </section>
// </div>
//
//
// <h4>AutoML Natural Language</h4>
// #### AutoML Natural Language
//
//
// <div class="ds-selector-tabs"><section><h5>Entity Extraction</h5>
// ##### Entity Extraction
//
// See [Preparing your training
// data](/natural-language/automl/entity-analysis/docs/prepare) for more
Expand Down Expand Up @@ -410,7 +409,7 @@ option ruby_package = "Google::Cloud::AutoML::V1";
//
//
//
// </section><section><h5>Classification</h5>
// ##### Classification
//
// See [Preparing your training
// data](https://cloud.google.com/natural-language/automl/docs/prepare) for more
Expand Down Expand Up @@ -457,7 +456,7 @@ option ruby_package = "Google::Cloud::AutoML::V1";
//
//
//
// </section><section><h5>Sentiment Analysis</h5>
// ##### Sentiment Analysis
//
// See [Preparing your training
// data](https://cloud.google.com/natural-language/automl/docs/prepare) for more
Expand Down Expand Up @@ -514,13 +513,10 @@ option ruby_package = "Google::Cloud::AutoML::V1";
// gs://folder/content.txt,3
// TEST,gs://folder/document.pdf
// VALIDATE,gs://folder/text_files.zip,2
// </section>
// </div>
//
//
//
// <h4>AutoML Tables</h4><div class="ui-datasection-main"><section
// class="selected">
// #### AutoML Tables
//
// See [Preparing your training
// data](https://cloud.google.com/automl-tables/docs/prepare) for more
Expand Down Expand Up @@ -559,8 +555,6 @@ option ruby_package = "Google::Cloud::AutoML::V1";
// and between 1000 and 100,000,000 rows, inclusive. There are at most 5
// import data running in parallel.
//
// </section>
// </div>
//
//
// **Input field definitions:**
Expand Down Expand Up @@ -641,16 +635,17 @@ message InputConfig {
// The source of the input.
oneof source {
// The Google Cloud Storage location for the input content.
// For [AutoMl.ImportData][google.cloud.automl.v1.AutoMl.ImportData], `gcs_source` points to a CSV file with
// a structure described in [InputConfig][google.cloud.automl.v1.InputConfig].
// For [AutoMl.ImportData][google.cloud.automl.v1.AutoMl.ImportData],
// `gcs_source` points to a CSV file with a structure described in
// [InputConfig][google.cloud.automl.v1.InputConfig].
GcsSource gcs_source = 1;
}

// Additional domain-specific parameters describing the semantic of the
// imported data, any string must be up to 25000
// characters long.
//
// <h4>AutoML Tables</h4>
// #### AutoML Tables
//
// `schema_inference_version`
// : (integer) This value must be supplied.
Expand All @@ -671,8 +666,8 @@ message InputConfig {
// non-terminal symbols defined near the end of this comment. The formats
// are:
//
// <h4>AutoML Vision</h4>
// <div class="ds-selector-tabs"><section><h5>Classification</h5>
// #### AutoML Vision
// ##### Classification
//
// One or more CSV files where each line is a single column:
//
Expand All @@ -688,7 +683,7 @@ message InputConfig {
// gs://folder/image2.gif
// gs://folder/image3.png
//
// </section><section><h5>Object Detection</h5>
// ##### Object Detection
//
// One or more CSV files where each line is a single column:
//
Expand All @@ -703,11 +698,9 @@ message InputConfig {
// gs://folder/image1.jpeg
// gs://folder/image2.gif
// gs://folder/image3.png
// </section>
// </div>
//
// <h4>AutoML Video Intelligence</h4>
// <div class="ds-selector-tabs"><section><h5>Classification</h5>
// #### AutoML Video Intelligence
// ##### Classification
//
// One or more CSV files where each line is a single column:
//
Expand All @@ -726,7 +719,7 @@ message InputConfig {
// gs://folder/video1.mp4,20,60
// gs://folder/vid2.mov,0,inf
//
// </section><section><h5>Object Tracking</h5>
// ##### Object Tracking
//
// One or more CSV files where each line is a single column:
//
Expand All @@ -744,11 +737,9 @@ message InputConfig {
// gs://folder/video1.mp4,10,40
// gs://folder/video1.mp4,20,60
// gs://folder/vid2.mov,0,inf
// </section>
// </div>
//
// <h4>AutoML Natural Language</h4>
// <div class="ds-selector-tabs"><section><h5>Classification</h5>
// #### AutoML Natural Language
// ##### Classification
//
// One or more CSV files where each line is a single column:
//
Expand All @@ -765,7 +756,7 @@ message InputConfig {
// gs://folder/text2.pdf
// gs://folder/text3.tif
//
// </section><section><h5>Sentiment Analysis</h5>
// ##### Sentiment Analysis
// One or more CSV files where each line is a single column:
//
// GCS_FILE_PATH
Expand All @@ -781,7 +772,7 @@ message InputConfig {
// gs://folder/text2.pdf
// gs://folder/text3.tif
//
// </section><section><h5>Entity Extraction</h5>
// ##### Entity Extraction
//
// One or more JSONL (JSON Lines) files that either provide inline text or
// documents. You can only use one format, either inline text or documents,
Expand Down Expand Up @@ -851,11 +842,8 @@ message InputConfig {
// }
// }
// }
// </section>
// </div>
//
// <h4>AutoML Tables</h4><div class="ui-datasection-main"><section
// class="selected">
// #### AutoML Tables
//
// See [Preparing your training
// data](https://cloud.google.com/automl-tables/docs/predict-batch) for more
Expand Down Expand Up @@ -901,8 +889,6 @@ message InputConfig {
// input feature column specs must contain values compatible with the
// column spec's data types. Prediction on all the rows of the table
// will be attempted.
// </section>
// </div>
//
// **Input field definitions:**
//
Expand Down Expand Up @@ -984,9 +970,10 @@ message DocumentInputConfig {
message OutputConfig {
// The destination of the output.
oneof destination {
// Required. The Google Cloud Storage location where the output is to be written to.
// For Image Object Detection, Text Extraction, Video Classification and
// Tables, in the given directory a new directory will be created with name:
// Required. The Google Cloud Storage location where the output is to be
// written to. For Image Object Detection, Text Extraction, Video
// Classification and Tables, in the given directory a new directory will be
// created with name:
// export_data-<dataset-display-name>-<timestamp-of-export-call> where
// timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. All export
// output will be written into that directory.
Expand Down Expand Up @@ -1246,8 +1233,8 @@ message OutputConfig {
message BatchPredictOutputConfig {
// The destination of the output.
oneof destination {
// Required. The Google Cloud Storage location of the directory where the output is to
// be written to.
// Required. The Google Cloud Storage location of the directory where the
// output is to be written to.
GcsDestination gcs_destination = 1 [(google.api.field_behavior) = REQUIRED];
}
}
Expand All @@ -1256,8 +1243,9 @@ message BatchPredictOutputConfig {
message ModelExportOutputConfig {
// The destination of the output.
oneof destination {
// Required. The Google Cloud Storage location where the model is to be written to.
// This location may only be set for the following model formats:
// Required. The Google Cloud Storage location where the model is to be
// written to. This location may only be set for the following model
// formats:
// "tflite", "edgetpu_tflite", "tf_saved_model", "tf_js", "core_ml".
//
// Under the directory given as the destination a new one with name
Expand Down
3 changes: 3 additions & 0 deletions packages/google-cloud-automl/protos/protos.json
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 62687be

Please sign in to comment.