Skip to content

Commit

Permalink
docs: clarified wording around quota usage
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 516225429

Source-Link: googleapis/googleapis@c13a985

Source-Link: googleapis/googleapis-gen@7bf5248
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiN2JmNTI0OGZhMWQ3MjQwMDZhNTg5ZTA3ZDkwMjk5NTFjNzRhOGJjNiJ9
  • Loading branch information
gcf-owl-bot[bot] committed Mar 13, 2023
1 parent badd386 commit a1ee941
Show file tree
Hide file tree
Showing 1,554 changed files with 637,055 additions and 0 deletions.
13 changes: 13 additions & 0 deletions owl-bot-staging/v1/.coveragerc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
[run]
branch = True

[report]
show_missing = True
omit =
google/cloud/aiplatform/v1/schema/trainingjob/definition/__init__.py
google/cloud/aiplatform/v1/schema/trainingjob/definition/gapic_version.py
exclude_lines =
# Re-enable the standard pragma
pragma: NO COVER
# Ignore debug-only repr
def __repr__
33 changes: 33 additions & 0 deletions owl-bot-staging/v1/.flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# -*- coding: utf-8 -*-
#
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# Generated by synthtool. DO NOT EDIT!
[flake8]
ignore = E203, E266, E501, W503
exclude =
# Exclude generated code.
**/proto/**
**/gapic/**
**/services/**
**/types/**
*_pb2.py

# Standard linting exemptions.
**/.nox/**
__pycache__,
.git,
*.pyc,
conf.py
2 changes: 2 additions & 0 deletions owl-bot-staging/v1/MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
recursive-include google/cloud/aiplatform/v1/schema/trainingjob/definition *.py
recursive-include google/cloud/aiplatform/v1/schema/trainingjob/definition_v1 *.py
49 changes: 49 additions & 0 deletions owl-bot-staging/v1/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
Python Client for Google Cloud Aiplatform V1 Schema Trainingjob Definition API
=================================================

Quick Start
-----------

In order to use this library, you first need to go through the following steps:

1. `Select or create a Cloud Platform project.`_
2. `Enable billing for your project.`_
3. Enable the Google Cloud Aiplatform V1 Schema Trainingjob Definition API.
4. `Setup Authentication.`_

.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html

Installation
~~~~~~~~~~~~

Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
create isolated Python environments. The basic problem it addresses is one of
dependencies and versions, and indirectly permissions.

With `virtualenv`_, it's possible to install this library without needing system
install permissions, and without clashing with the installed system
dependencies.

.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/


Mac/Linux
^^^^^^^^^

.. code-block:: console
python3 -m venv <your-env>
source <your-env>/bin/activate
<your-env>/bin/pip install /path/to/library
Windows
^^^^^^^

.. code-block:: console
python3 -m venv <your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exe install \path\to\library
10 changes: 10 additions & 0 deletions owl-bot-staging/v1/docs/aiplatform_v1/dataset_service.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
DatasetService
--------------------------------

.. automodule:: google.cloud.aiplatform_v1.services.dataset_service
:members:
:inherited-members:

.. automodule:: google.cloud.aiplatform_v1.services.dataset_service.pagers
:members:
:inherited-members:
10 changes: 10 additions & 0 deletions owl-bot-staging/v1/docs/aiplatform_v1/endpoint_service.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
EndpointService
---------------------------------

.. automodule:: google.cloud.aiplatform_v1.services.endpoint_service
:members:
:inherited-members:

.. automodule:: google.cloud.aiplatform_v1.services.endpoint_service.pagers
:members:
:inherited-members:
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
FeaturestoreOnlineServingService
--------------------------------------------------

.. automodule:: google.cloud.aiplatform_v1.services.featurestore_online_serving_service
:members:
:inherited-members:
10 changes: 10 additions & 0 deletions owl-bot-staging/v1/docs/aiplatform_v1/featurestore_service.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
FeaturestoreService
-------------------------------------

.. automodule:: google.cloud.aiplatform_v1.services.featurestore_service
:members:
:inherited-members:

.. automodule:: google.cloud.aiplatform_v1.services.featurestore_service.pagers
:members:
:inherited-members:
10 changes: 10 additions & 0 deletions owl-bot-staging/v1/docs/aiplatform_v1/index_endpoint_service.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
IndexEndpointService
--------------------------------------

.. automodule:: google.cloud.aiplatform_v1.services.index_endpoint_service
:members:
:inherited-members:

.. automodule:: google.cloud.aiplatform_v1.services.index_endpoint_service.pagers
:members:
:inherited-members:
10 changes: 10 additions & 0 deletions owl-bot-staging/v1/docs/aiplatform_v1/index_service.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
IndexService
------------------------------

.. automodule:: google.cloud.aiplatform_v1.services.index_service
:members:
:inherited-members:

.. automodule:: google.cloud.aiplatform_v1.services.index_service.pagers
:members:
:inherited-members:
10 changes: 10 additions & 0 deletions owl-bot-staging/v1/docs/aiplatform_v1/job_service.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
JobService
----------------------------

.. automodule:: google.cloud.aiplatform_v1.services.job_service
:members:
:inherited-members:

.. automodule:: google.cloud.aiplatform_v1.services.job_service.pagers
:members:
:inherited-members:
10 changes: 10 additions & 0 deletions owl-bot-staging/v1/docs/aiplatform_v1/metadata_service.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
MetadataService
---------------------------------

.. automodule:: google.cloud.aiplatform_v1.services.metadata_service
:members:
:inherited-members:

.. automodule:: google.cloud.aiplatform_v1.services.metadata_service.pagers
:members:
:inherited-members:
10 changes: 10 additions & 0 deletions owl-bot-staging/v1/docs/aiplatform_v1/migration_service.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
MigrationService
----------------------------------

.. automodule:: google.cloud.aiplatform_v1.services.migration_service
:members:
:inherited-members:

.. automodule:: google.cloud.aiplatform_v1.services.migration_service.pagers
:members:
:inherited-members:
10 changes: 10 additions & 0 deletions owl-bot-staging/v1/docs/aiplatform_v1/model_service.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
ModelService
------------------------------

.. automodule:: google.cloud.aiplatform_v1.services.model_service
:members:
:inherited-members:

.. automodule:: google.cloud.aiplatform_v1.services.model_service.pagers
:members:
:inherited-members:
10 changes: 10 additions & 0 deletions owl-bot-staging/v1/docs/aiplatform_v1/pipeline_service.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
PipelineService
---------------------------------

.. automodule:: google.cloud.aiplatform_v1.services.pipeline_service
:members:
:inherited-members:

.. automodule:: google.cloud.aiplatform_v1.services.pipeline_service.pagers
:members:
:inherited-members:
6 changes: 6 additions & 0 deletions owl-bot-staging/v1/docs/aiplatform_v1/prediction_service.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
PredictionService
-----------------------------------

.. automodule:: google.cloud.aiplatform_v1.services.prediction_service
:members:
:inherited-members:
20 changes: 20 additions & 0 deletions owl-bot-staging/v1/docs/aiplatform_v1/services.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Services for Google Cloud Aiplatform v1 API
===========================================
.. toctree::
:maxdepth: 2

dataset_service
endpoint_service
featurestore_online_serving_service
featurestore_service
index_endpoint_service
index_service
job_service
metadata_service
migration_service
model_service
pipeline_service
prediction_service
specialist_pool_service
tensorboard_service
vizier_service
10 changes: 10 additions & 0 deletions owl-bot-staging/v1/docs/aiplatform_v1/specialist_pool_service.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
SpecialistPoolService
---------------------------------------

.. automodule:: google.cloud.aiplatform_v1.services.specialist_pool_service
:members:
:inherited-members:

.. automodule:: google.cloud.aiplatform_v1.services.specialist_pool_service.pagers
:members:
:inherited-members:
10 changes: 10 additions & 0 deletions owl-bot-staging/v1/docs/aiplatform_v1/tensorboard_service.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
TensorboardService
------------------------------------

.. automodule:: google.cloud.aiplatform_v1.services.tensorboard_service
:members:
:inherited-members:

.. automodule:: google.cloud.aiplatform_v1.services.tensorboard_service.pagers
:members:
:inherited-members:
6 changes: 6 additions & 0 deletions owl-bot-staging/v1/docs/aiplatform_v1/types.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Types for Google Cloud Aiplatform v1 API
========================================

.. automodule:: google.cloud.aiplatform_v1.types
:members:
:show-inheritance:
10 changes: 10 additions & 0 deletions owl-bot-staging/v1/docs/aiplatform_v1/vizier_service.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
VizierService
-------------------------------

.. automodule:: google.cloud.aiplatform_v1.services.vizier_service
:members:
:inherited-members:

.. automodule:: google.cloud.aiplatform_v1.services.vizier_service.pagers
:members:
:inherited-members:
Loading

0 comments on commit a1ee941

Please sign in to comment.