Skip to content

Commit 65facf1

Browse files
gguussleahecole
gguuss
authored and
leahecole
committed
Adds new examples, replaces markdown with restructured text [(#945)](#945)
* Adds new examples, replaces markdown with restructured text * Address review feedback * Use videos from pubilc bucket, update to new client library. * Style nit
1 parent 8bbebaf commit 65facf1

File tree

6 files changed

+276
-53
lines changed

6 files changed

+276
-53
lines changed

‎videointelligence/samples/analyze/README.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

‎videointelligence/samples/analyze/README.rst

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
.. This file is automatically generated. Do not edit this file directly.
2+
3+
Google Cloud Video Intelligence API Python Samples
4+
===============================================================================
5+
6+
This directory contains samples for Google Cloud Video Intelligence API. `Google Cloud Video Intelligence API`_ allows developers to easily integrate feature detection in video.
7+
8+
9+
10+
11+
.. _Google Cloud Video Intelligence API: https://cloud.google.com/video-intelligence/docs
12+
13+
Setup
14+
-------------------------------------------------------------------------------
15+
16+
17+
Authentication
18+
++++++++++++++
19+
20+
Authentication is typically done through `Application Default Credentials`_,
21+
which means you do not have to change the code to authenticate as long as
22+
your environment has credentials. You have a few options for setting up
23+
authentication:
24+
25+
#. When running locally, use the `Google Cloud SDK`_
26+
27+
.. code-block:: bash
28+
29+
gcloud auth application-default login
30+
31+
32+
#. When running on App Engine or Compute Engine, credentials are already
33+
set-up. However, you may need to configure your Compute Engine instance
34+
with `additional scopes`_.
35+
36+
#. You can create a `Service Account key file`_. This file can be used to
37+
authenticate to Google Cloud Platform services from any environment. To use
38+
the file, set the ``GOOGLE_APPLICATION_CREDENTIALS`` environment variable to
39+
the path to the key file, for example:
40+
41+
.. code-block:: bash
42+
43+
export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service_account.json
44+
45+
.. _Application Default Credentials: https://cloud.google.com/docs/authentication#getting_credentials_for_server-centric_flow
46+
.. _additional scopes: https://cloud.google.com/compute/docs/authentication#using
47+
.. _Service Account key file: https://developers.google.com/identity/protocols/OAuth2ServiceAccount#creatinganaccount
48+
49+
Install Dependencies
50+
++++++++++++++++++++
51+
52+
#. Install `pip`_ and `virtualenv`_ if you do not already have them.
53+
54+
#. Create a virtualenv. Samples are compatible with Python 2.7 and 3.4+.
55+
56+
.. code-block:: bash
57+
58+
$ virtualenv env
59+
$ source env/bin/activate
60+
61+
#. Install the dependencies needed to run the samples.
62+
63+
.. code-block:: bash
64+
65+
$ pip install -r requirements.txt
66+
67+
.. _pip: https://pip.pypa.io/
68+
.. _virtualenv: https://virtualenv.pypa.io/
69+
70+
Samples
71+
-------------------------------------------------------------------------------
72+
73+
analyze
74+
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
75+
76+
77+
78+
To run this sample:
79+
80+
.. code-block:: bash
81+
82+
$ python analyze.py
83+
84+
usage: analyze.py [-h] {faces,labels,labels_file,safe_search,shots} ...
85+
86+
This application demonstrates face detection, label detection, safe search,
87+
and shot change detection using the Google Cloud API.
88+
89+
Usage Examples:
90+
91+
python analyze.py faces gs://cloudmleap/video/next/volleyball_court.mp4
92+
python analyze.py labels gs://cloudmleap/video/next/fox-snatched.mp4
93+
python analyze.py labels_file resources/fox-snatched.mp4
94+
python analyze.py shots gs://cloudmleap/video/next/gbikes_dinosaur.mp4
95+
python analyze.py safe_search gs://cloudmleap/video/next/animals.mp4
96+
97+
positional arguments:
98+
{faces,labels,labels_file,safe_search,shots}
99+
faces Detects faces given a GCS path.
100+
labels Detects labels given a GCS path.
101+
labels_file Detects labels given a file path.
102+
safe_search Detects safe search features the GCS path to a video.
103+
shots Detects camera shot changes.
104+
105+
optional arguments:
106+
-h, --help show this help message and exit
107+
108+
109+
110+
111+
The client library
112+
-------------------------------------------------------------------------------
113+
114+
This sample uses the `Google Cloud Client Library for Python`_.
115+
You can read the documentation for more details on API usage and use GitHub
116+
to `browse the source`_ and `report issues`_.
117+
118+
.. Google Cloud Client Library for Python:
119+
https://googlecloudplatform.github.io/google-cloud-python/
120+
.. browse the source:
121+
https://github.com/GoogleCloudPlatform/google-cloud-python
122+
.. report issues:
123+
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
124+
125+
126+
.. _Google Cloud SDK: https://cloud.google.com/sdk/

‎videointelligence/samples/analyze/README.rst.in

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# This file is used to generate README.rst
2+
3+
product:
4+
name: Google Cloud Video Intelligence API
5+
short_name: Cloud Video Intelligence API
6+
url: https://cloud.google.com/video-intelligence/docs
7+
description: >
8+
`Google Cloud Video Intelligence API`_ allows developers to easily
9+
integrate feature detection in video.
10+
11+
setup:
12+
- auth
13+
- install_deps
14+
15+
samples:
16+
- name: analyze
17+
file: analyze.py
18+
show_help: True
19+
20+
cloud_client_library: true

0 commit comments

Comments
 (0)