8000 Update READMEs to fix numbering and add git clone [(#1464)](https://g… · googleapis/google-cloud-python@54bbeea · GitHub
[go: up one dir, main page]
Skip to content

Commit 54bbeea

Browse files
frankynbusunkim96
frankyn
authored and
busunkim96
committed
Update READMEs to fix numbering and add git clone [(#1464)](GoogleCloudPlatform/python-docs-samples#1464)
1 parent 22788d5 commit 54bbeea

File tree

1 file changed

+35
-23
lines changed
  • packages/google-cloud-speech/samples/snippets

1 file changed

+35
-23
lines changed

‎packages/google-cloud-speech/samples/snippets/README.rst‎

Lines changed: 35 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,16 @@ credentials for applications.
3535
Install Dependencies
3636
++++++++++++++++++++
3737

38+
#. Clone python-docs-samples and change directory to the sample directory you want to use.
39+
40+
.. code-block:: bash
41+
42+
$ git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
43+
3844
#. Install `pip`_ and `virtualenv`_ if you do not already have them. You may want to refer to the `Python Development Environment Setup Guide`_ for Google Cloud Platform for instructions.
3945

40-
.. _Python Development Environment Setup Guide:
41-
https://cloud.google.com/python/setup
46+
.. _Python Development Environment Setup Guide:
47+
https://cloud.google.com/python/setup
4248

4349
#. Create a virtualenv. Samples are compatible with Python 2.7 and 3.4+.
4450

@@ -91,21 +97,22 @@ To run this sample:
9197
$ python transcribe.py
9298
9399
usage: transcribe.py [-h] path
94-
100+
95101
Google Cloud Speech API sample application using the REST API for batch
96102
processing.
97-
103+
98104
Example usage:
99105
python transcribe.py resources/audio.raw
100106
python transcribe.py gs://cloud-samples-tests/speech/brooklyn.flac
101-
107+
102108
positional arguments:
103109
path File or GCS path for audio file to be recognized
104-
110+
105111
optional arguments:
106112
-h, --help show this help message and exit
107113
108114
115+
109116
Transcribe async
110117
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
111118

@@ -122,21 +129,22 @@ To run this sample:
122129
$ python transcribe_async.py
123130
124131
usage: transcribe_async.py [-h] path
125-
132+
126133
Google Cloud Speech API sample application using the REST API for async
127134
batch processing.
128-
135+
129136
Example usage:
130137
python transcribe_async.py resources/audio.raw
131138
python transcribe_async.py gs://cloud-samples-tests/speech/vr.flac
132-
139+
133140
positional arguments:
134141
path File or GCS path for audio file to be recognized
135-
142+
136143
optional arguments:
137144
-h, --help show this help message and exit
138145
139146
147+
140148
Transcribe with word time offsets
141149
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
142150

@@ -153,20 +161,21 @@ To run this sample:
153161
$ python transcribe_word_time_offsets.py
154162
155163
usage: transcribe_word_time_offsets.py [-h] path
156-
164+
157165
Google Cloud Speech API sample that demonstrates word time offsets.
158-
166+
159167
Example usage:
160168
python transcribe_word_time_offsets.py resources/audio.raw
161169
python transcribe_word_time_offsets.py gs://cloud-samples-tests/speech/vr.flac
162-
170+
163171
positional arguments:
164172
path File or GCS path for audio file to be recognized
165-
173+
166174
optional arguments:
167175
-h, --help show this help message and exit
168176
169177
178+
170179
Transcribe Streaming
171180
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
172181

@@ -183,24 +192,25 @@ To run this sample:
183192
$ python transcribe_streaming.py
184193
185194
usage: transcribe_streaming.py [-h] stream
186-
195+
187196
Google Cloud Speech API sample application using the streaming API.
188-
197+
189198
Example usage:
190199
python transcribe_streaming.py resources/audio.raw
191-
200+
192201
positional arguments:
193202
stream File to stream to the API
194-
203+
195204
optional arguments:
196205
-h, --help show this help message and exit
197206
198207
208+
199209
Beta Samples
200210
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
201211

202212
.. image:: https://gstatic.com/cloudssh/images/open-btn.png
203-
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=speech/cloud-client/beta_snippets.py;speech/cloud-client/README.rst
213+
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=speech/cloud-client/beta_snippets.py,speech/cloud-client/README.rst
204214

205215

206216

@@ -212,24 +222,26 @@ To run this sample:
212222
$ python beta_snippets.py
213223
214224
usage: beta_snippets.py [-h] command path
215-
225+
216226
Google Cloud Speech API sample that demonstrates enhanced models
217227
and recognition metadata.
218-
228+
219229
Example usage:
220230
python beta_snippets.py enhanced-model resources/commercial_mono.wav
221231
python beta_snippets.py metadata resources/commercial_mono.wav
222-
232+
python beta_snippets.py punctuation resources/commercial_mono.wav
233+
223234
positional arguments:
224235
command
225236
path File for audio file to be recognized
226-
237+
227238
optional arguments:
228239
-h, --help show this help message and exit
229240
230241
231242
232243
244+
233245
The client library
234246
-------------------------------------------------------------------------------
235247

0 commit comments

Comments
 (0)
0