Merge pull request #2 from nvidia-riva/change_namespace

Change namespace and rename package.

Author: PeganovAnton

.gitignore

@@ -62,12 +62,8 @@ __pycache__/
 *.py[cod]
 *$py.class
 
-# C extensions
-*.so
-
 # Distribution / packaging
 .Python
-riva/
 build/
 develop-eggs/
 dist/
@@ -187,3 +183,6 @@ tests/integration/asr/outputs
 tests/integration/nlp/outputs
 tests/integration/tts/outputs
 
+riva/client/proto/*_pb2.py
+riva/client/proto/*_pb2_grpc.py
+

README.md

@@ -6,9 +6,9 @@ case and deliver real-time performance. This repo provides performant client exa
 
 ## Main API
 
-- `riva_api.ASRService` is a class for speech recognition,
-- `riva_api.TTSService` is a class for speech synthesis,
-- `riva_api.NLPService` is a class for natural language processing.
+- `riva.client.ASRService` is a class for speech recognition,
+- `riva.client.TTSService` is a class for speech synthesis,
+- `riva.client.NLPService` is a class for natural language processing.
 
 ## CLI interface
 
@@ -43,12 +43,12 @@ pip install --force-reinstall dist/*.whl
 ```
 3. `pip`:
 ```bash
-pip install riva-api
+pip install nvidia-riva-client
 ```
 
 If you would like to use output and input audio devices 
 (scripts `scripts/asr/transcribe_file_rt.py`, `scripts/asr/transcribe_mic.py`, `scripts/tts/talk.py` or module 
-`riva_api/audio_io.py`), you will need to install `PyAudio`.
+`riva.client/audio_io.py`), you will need to install `PyAudio`.
 ```bash
 conda install -c anaconda pyaudio
 ```

riva_api/__init__.py renamed to riva/client/__init__.py

@@ -1,7 +1,7 @@
 # SPDX-FileCopyrightText: Copyright (c) 2022 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 # SPDX-License-Identifier: MIT
 
-from riva_api.asr import (
+from riva.client.asr import (
     AudioChunkFileIterator,
     ASRService,
     add_audio_file_specs_to_config,
@@ -11,15 +11,15 @@
     print_streaming,
     sleep_audio_length,
 )
-from riva_api.auth import Auth
-from riva_api.nlp import (
+from riva.client.auth import Auth
+from riva.client.nlp import (
     NLPService,
     extract_all_text_classes_and_confidences,
     extract_all_token_classification_predictions,
     extract_most_probable_text_class_and_confidence,
     extract_most_probable_token_classification_predictions,
 )
-from riva_api.package_info import (
+from riva.client.package_info import (
     __contact_emails__,
     __contact_names__,
     __description__,
@@ -32,7 +32,7 @@
     __shortversion__,
     __version__,
 )
-from riva_api.proto.riva_asr_pb2 import RecognitionConfig, StreamingRecognitionConfig
-from riva_api.proto.riva_audio_pb2 import AudioEncoding
-from riva_api.proto.riva_nlp_pb2 import AnalyzeIntentOptions
-from riva_api.tts import SpeechSynthesisService
+from riva.client.proto.riva_asr_pb2 import RecognitionConfig, StreamingRecognitionConfig
+from riva.client.proto.riva_audio_pb2 import AudioEncoding
+from riva.client.proto.riva_nlp_pb2 import AnalyzeIntentOptions
+from riva.client.tts import SpeechSynthesisService

riva_api/argparse_utils.py renamed to riva/client/argparse_utils.py

@@ -12,9 +12,9 @@
 
 from grpc._channel import _MultiThreadedRendezvous
 
-import riva_api.proto.riva_asr_pb2 as rasr
-import riva_api.proto.riva_asr_pb2_grpc as rasr_srv
-from riva_api.auth import Auth
+import riva.client.proto.riva_asr_pb2 as rasr
+import riva.client.proto.riva_asr_pb2_grpc as rasr_srv
+from riva.client.auth import Auth
 
 
 def get_wav_file_parameters(input_file: Union[str, os.PathLike]) -> Dict[str, Union[int, float]]:
@@ -114,7 +114,7 @@ def print_streaming(
     Prints streaming speech recognition results to provided files or streams.
 
     Args:
-        responses (:obj:`Iterable[riva_api.proto.riva_asr_pb2.StreamingRecognizeResponse]`): responses acquired during
+        responses (:obj:`Iterable[riva.client.proto.riva_asr_pb2.StreamingRecognizeResponse]`): responses acquired during
             streaming speech recognition.
         output_file (:obj:`Union[Union[os.PathLike, str, TextIO], List[Union[os.PathLike, str, TextIO]]]`, `optional`):
             a path to an output file or a text stream or a list of paths/streams. If contains several elements, then
@@ -261,7 +261,7 @@ def __init__(self, auth: Auth) -> None:
         Initializes an instance of the class.
 
         Args:
-            auth (:obj:`riva_api.auth.Auth`): an instance of :class:`riva_api.auth.Auth` which is used for
+            auth (:obj:`riva.client.auth.Auth`): an instance of :class:`riva.client.auth.Auth` which is used for
                 authentication metadata generation.
         """
         self.auth = auth
@@ -287,20 +287,20 @@ def streaming_response_generator(
                     with wave.open(file_name, 'rb') as wav_f:
                         raw_audio = wav_f.readframes(n_frames)
 
-            streaming_config (:obj:`riva_api.proto.riva_asr_pb2.StreamingRecognitionConfig`): a config for streaming.
+            streaming_config (:obj:`riva.client.proto.riva_asr_pb2.StreamingRecognitionConfig`): a config for streaming.
                 You may find description of config fields in message ``StreamingRecognitionConfig`` in
                 `common repo
                 <https://docs.nvidia.com/deeplearning/riva/user-guide/docs/reference/protos/protos.html#riva-proto-riva-asr-proto>`_.
                 An example of creation of streaming config:
 
                 .. code-style:: python
 
-                    from riva_api import RecognitionConfig, StreamingRecognitionConfig
+                    from riva.client import RecognitionConfig, StreamingRecognitionConfig
                     config = RecognitionConfig(enable_automatic_punctuation=True)
                     streaming_config = StreamingRecognitionConfig(config, interim_results=True)
 
         Yields:
-            :obj:`riva_api.proto.riva_asr_pb2.StreamingRecognizeResponse`: responses for audio chunks in
+            :obj:`riva.client.proto.riva_asr_pb2.StreamingRecognizeResponse`: responses for audio chunks in
             :param:`audio_chunks`. You may find description of response fields in declaration of
             ``StreamingRecognizeResponse``
             message `here
@@ -326,21 +326,21 @@ def offline_recognize(
                     with wave.open(file_name, 'rb') as wav_f:
                         raw_audio = wav_f.readframes(n_frames)
 
-            config (:obj:`riva_api.proto.riva_asr_pb2.RecognitionConfig`): a config for offline speech recognition.
+            config (:obj:`riva.client.proto.riva_asr_pb2.RecognitionConfig`): a config for offline speech recognition.
                 You may find description of config fields in message ``RecognitionConfig`` in
                 `common repo
                 <https://docs.nvidia.com/deeplearning/riva/user-guide/docs/reference/protos/protos.html#riva-proto-riva-asr-proto>`_.
                 An example of creation of config:
 
                 .. code-style:: python
 
-                    from riva_api import RecognitionConfig
+                    from riva.client import RecognitionConfig
                     config = RecognitionConfig(enable_automatic_punctuation=True)
             future (:obj:`bool`, defaults to :obj:`False`): whether to return an async result instead of usual
                 response. You can get a response by calling ``result()`` method of the future object.
 
         Returns:
-            :obj:`Union[riva_api.proto.riva_asr_pb2.RecognizeResponse, grpc._channel._MultiThreadedRendezvous]``: a
+            :obj:`Union[riva.client.proto.riva_asr_pb2.RecognizeResponse, grpc._channel._MultiThreadedRendezvous]``: a
             response with results of :param:`audio_bytes` processing. You may find description of response fields in
             declaration of ``RecognizeResponse`` message `here
             <https://docs.nvidia.com/deeplearning/riva/user-guide/docs/reference/protos/protos.html#riva-proto-riva-asr-proto>`_.

riva_api/asr.py renamed to riva/client/asr.py

@@ -6,9 +6,9 @@
 from google.protobuf.message import Message
 from grpc._channel import _MultiThreadedRendezvous
 
-import riva_api.proto.riva_nlp_pb2 as rnlp
-import riva_api.proto.riva_nlp_pb2_grpc as rnlp_srv
-from riva_api import Auth
+import riva.client.proto.riva_nlp_pb2 as rnlp
+import riva.client.proto.riva_nlp_pb2_grpc as rnlp_srv
+from riva.client import Auth
 
 
 def extract_all_text_classes_and_confidences(
@@ -103,7 +103,7 @@ def __init__(self, auth: Auth) -> None:
         Initializes an instance of the class.
 
         Args:
-            auth (:obj:`Auth`): an instance of :class:`riva_api.auth.Auth` which is used for
+            auth (:obj:`Auth`): an instance of :class:`riva.client.auth.Auth` which is used for
                 authentication metadata generation.
         """
         self.auth = auth
@@ -125,7 +125,7 @@ def classify_text(
             future (:obj:`bool`, defaults to :obj:`False`): whether to return an async result instead of usual
                 response. You can get a response by calling ``result()`` method of the future object.
         Returns:
-            :obj:`Union[riva_api.proto.riva_nlp_pb2.TextClassResponse, grpc._channel._MultiThreadedRendezvous]`: a
+            :obj:`Union[riva.client.proto.riva_nlp_pb2.TextClassResponse, grpc._channel._MultiThreadedRendezvous]`: a
             response with :param:`input_strings` classification results. You may find :class:`TextClassResponse`
             fields description `here
             <https://docs.nvidia.com/deeplearning/riva/user-guide/docs/reference/protos/protos.html#riva-proto-riva-nlp-proto>`_.
@@ -158,7 +158,7 @@ def classify_tokens(
             future (:obj:`bool`, defaults to :obj:`False`): whether to return an async result instead of usual
                 response. You can get a response by calling ``result()`` method of the future object.
         Returns:
-            :obj:`Union[riva_api.proto.riva_nlp_pb2.TokenClassResponse, grpc._channel._MultiThreadedRendezvous]`: a
+            :obj:`Union[riva.client.proto.riva_nlp_pb2.TokenClassResponse, grpc._channel._MultiThreadedRendezvous]`: a
             response with results. You may find :class:`TokenClassResponse` fields description `here
             <https://docs.nvidia.com/deeplearning/riva/user-guide/docs/reference/protos/protos.html#riva-proto-riva-nlp-proto>`_.
             If :param:`future` is :obj:`True`, then a future object is returned. You may retrieve a response from a
@@ -189,7 +189,7 @@ def transform_text(
             future (:obj:`bool`, defaults to :obj:`False`): whether to return an async result instead of usual
                 response. You can get a response by calling ``result()`` method of the future object.
         Returns:
-            :obj:`Union[riva_api.proto.riva_nlp_pb2.TextTransformResponse, grpc._channel._MultiThreadedRendezvous]`: a
+            :obj:`Union[riva.client.proto.riva_nlp_pb2.TextTransformResponse, grpc._channel._MultiThreadedRendezvous]`: a
             model response. You may find :class:`TextTransformResponse` fields description `here
             <https://docs.nvidia.com/deeplearning/riva/user-guide/docs/reference/protos/protos.html#riva-proto-riva-nlp-proto>`_.
             If :param:`future` is :obj:`True`, then a future object is returned. You may retrieve a response from a
@@ -211,7 +211,7 @@ def analyze_entities(
             future (:obj:`bool`, defaults to :obj:`False`): whether to return an async result instead of usual
                 response. You can get a response by calling ``result()`` method of the future object.
         Returns:
-            :obj:`Union[riva_api.proto.riva_nlp_pb2.TokenClassResponse, grpc._channel._MultiThreadedRendezvous]`: a
+            :obj:`Union[riva.client.proto.riva_nlp_pb2.TokenClassResponse, grpc._channel._MultiThreadedRendezvous]`: a
             model response. You may find :class:`TokenClassResponse` fields description `here
             <https://docs.nvidia.com/deeplearning/riva/user-guide/docs/reference/protos/protos.html#riva-proto-riva-nlp-proto>`_.
             If :param:`future` is :obj:`True`, then a future object is returned. You may retrieve a response from a
@@ -233,15 +233,15 @@ def analyze_intent(
 
         Args:
             input_string (:obj:`str`): a string which will be classified.
-            options (:obj:`riva_api.proto.riva_nlp_pb2.AnalyzeIntentOptions`, `optional`,
-                defaults to :obj:`riva_api.proto.riva_nlp_pb2.AnalyzeIntentOptions()`):
+            options (:obj:`riva.client.proto.riva_nlp_pb2.AnalyzeIntentOptions`, `optional`,
+                defaults to :obj:`riva.client.proto.riva_nlp_pb2.AnalyzeIntentOptions()`):
                 an intent options. You may find fields description `here
                 <https://docs.nvidia.com/deeplearning/riva/user-guide/docs/reference/protos/protos.html#riva-proto-riva-nlp-proto>`_.
                 Defaults to an instance of :obj:`AnalyzeIntentOptions` created without parameters.
             future (:obj:`bool`, defaults to :obj:`False`): whether to return an async result instead of usual
                 response. You can get a response by calling ``result()`` method of the future object.
         Returns:
-            :obj:`Union[riva_api.proto.riva_nlp_pb2.AnalyzeIntentResponse, grpc._channel._MultiThreadedRendezvous]`: a
+            :obj:`Union[riva.client.proto.riva_nlp_pb2.AnalyzeIntentResponse, grpc._channel._MultiThreadedRendezvous]`: a
             response with results. You may find fields description `here
             <https://docs.nvidia.com/deeplearning/riva/user-guide/docs/reference/protos/protos.html#riva-proto-riva-nlp-proto>`_.
             If :param:`future` is :obj:`True`, then a future object is returned. You may retrieve a response from a
@@ -272,7 +272,7 @@ def punctuate_text(
             future (:obj:`bool`, defaults to :obj:`False`): whether to return an async result instead of usual
                 response. You can get a response by calling ``result()`` method of the future object.
         Returns:
-            :obj:`Union[riva_api.proto.riva_nlp_pb2.TextTransformResponse, grpc._channel._MultiThreadedRendezvous]`: a
+            :obj:`Union[riva.client.proto.riva_nlp_pb2.TextTransformResponse, grpc._channel._MultiThreadedRendezvous]`: a
             response with results. You may find fields description `here
             <https://docs.nvidia.com/deeplearning/riva/user-guide/docs/reference/protos/protos.html#riva-proto-riva-nlp-proto>`_.
             If :param:`future` is :obj:`True`, then a future object is returned. You may retrieve a response from a
@@ -296,7 +296,7 @@ def natural_query(
             future (:obj:`bool`, defaults to :obj:`False`): whether to return an async result instead of usual
                 response. You can get a response by calling ``result()`` method of the future object.
         Returns:
-            :obj:`Union[riva_api.proto.riva_nlp_pb2.NaturalQueryResult, grpc._channel._MultiThreadedRendezvous]`: a
+            :obj:`Union[riva.client.proto.riva_nlp_pb2.NaturalQueryResult, grpc._channel._MultiThreadedRendezvous]`: a
             response with a result. You may find fields description `here
             <https://docs.nvidia.com/deeplearning/riva/user-guide/docs/reference/protos/protos.html#riva-proto-riva-nlp-proto>`_.
             If :param:`future` is :obj:`True`, then a future object is returned. You may retrieve a response from a

riva_api/audio_io.py renamed to riva/client/audio_io.py

@@ -12,13 +12,13 @@
 __shortversion__ = '.'.join(map(str, VERSION[:3]))
 __version__ = '.'.join(map(str, VERSION[:3])) + ''.join(VERSION[3:])
 
-__package_name__ = 'riva-api'
+__package_name__ = 'nvidia-riva-client'
 __contact_names__ = 'Anton Peganov'
 __contact_emails__ = '[email protected]'
 __homepage__ = 'https://github.com/nvidia-riva/python-clients'
 __repository_url__ = 'https://github.com/nvidia-riva/python-clients'
 __download_url__ = 'hhttps://github.com/nvidia-riva/python-clients/releases'
-__description__ = "Python implementation of the Riva API"
+__description__ = "Python implementation of the Riva Client API"
 __license__ = 'MIT'
 __keywords__ = 'deep learning, machine learning, gpu, NLP, ASR, TTS, nvidia, speech, language, Riva, client'
 __riva_version__ = "2.2.0"