pvleopard 1.1.4__py3-none-any.whl → 1.2.0__py3-none-any.whl

pvleopard/__init__.py

@@ -1,5 +1,5 @@
 #
-# Copyright 2022 Picovoice Inc.
+# Copyright 2022-2023 Picovoice Inc.
 #
 # You may not use this file except in compliance with the license. A copy of the license is located in the "LICENSE"
 # file accompanying this source.
@@ -9,36 +9,6 @@
 # specific language governing permissions and limitations under the License.
 #
 
-from typing import *
-
-from .leopard import *
-from .util import *
-
-
-def create(
-        access_key: str,
-        model_path: Optional[str] = None,
-        library_path: Optional[str] = None,
-        enable_automatic_punctuation: bool = False) -> Leopard:
-    """
-    Factory method for Leopard speech-to-text engine.
-
-    :param access_key: AccessKey obtained from Picovoice Console (https://console.picovoice.ai/)
-    :param library_path: Absolute path to Leopard's dynamic library. If not set it will be set to the default location.
-    :param model_path: Absolute path to the file containing model parameters. If not set it will be set to the default
-    location.
-    :param enable_automatic_punctuation Set to `True` to enable automatic punctuation insertion.
-    :return: An instance of Leopard speech-to-text engine.
-    """
-
-    if model_path is None:
-        model_path = default_model_path('')
-
-    if library_path is None:
-        library_path = default_library_path('')
-
-    return Leopard(
-        access_key=access_key,
-        model_path=model_path,
-        library_path=library_path,
-        enable_automatic_punctuation=enable_automatic_punctuation)
+from ._factory import *
+from ._leopard import *
+from ._util import *

pvleopard/_factory.py

@@ -0,0 +1,49 @@
+#
+# Copyright 2023 Picovoice Inc.
+#
+# You may not use this file except in compliance with the license. A copy of the license is located in the "LICENSE"
+# file accompanying this source.
+#
+# 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.
+#
+
+from typing import *
+
+from ._leopard import Leopard
+from ._util import default_library_path, default_model_path
+
+
+def create(
+        access_key: str,
+        model_path: Optional[str] = None,
+        library_path: Optional[str] = None,
+        enable_automatic_punctuation: bool = False) -> Leopard:
+    """
+    Factory method for Leopard speech-to-text engine.
+
+    :param access_key: AccessKey obtained from Picovoice Console (https://console.picovoice.ai/)
+    :param library_path: Absolute path to Leopard's dynamic library. If not set it will be set to the default location.
+    :param model_path: Absolute path to the file containing model parameters. If not set it will be set to the default
+    location.
+    :param enable_automatic_punctuation Set to `True` to enable automatic punctuation insertion.
+    :return: An instance of Leopard speech-to-text engine.
+    """
+
+    if model_path is None:
+        model_path = default_model_path('')
+
+    if library_path is None:
+        library_path = default_library_path('')
+
+    return Leopard(
+        access_key=access_key,
+        model_path=model_path,
+        library_path=library_path,
+        enable_automatic_punctuation=enable_automatic_punctuation)
+
+
+__all__ = [
+    'create',
+]

pvleopard/{leopard.py → _leopard.py}

@@ -1,5 +1,5 @@
 #
-#    Copyright 2018-2022 Picovoice Inc.
+#    Copyright 2018-2023 Picovoice Inc.
 #
 #    You may not use this file except in compliance with the license. A copy of the license is located in the "LICENSE"
 #    file accompanying this source.
@@ -189,9 +189,17 @@ class Leopard(object):
 
         self._sample_rate = library.pv_sample_rate()
 
-        self._pv_free = library.pv_free
-        self._pv_free.argtypes = [c_void_p]
-        self._pv_free.restype = None
+        self._transcript_delete_func = library.pv_leopard_transcript_delete
+        self._transcript_delete_func.argtypes = [
+            c_char_p
+        ]
+        self._transcript_delete_func.restype = None
+
+        self._words_delete_func = library.pv_leopard_words_delete
+        self._words_delete_func.argtypes = [
+            POINTER(self.CWord)
+        ]
+        self._words_delete_func.restype = None
 
     Word = namedtuple('Word', ['word', 'start_sec', 'end_sec', 'confidence'])
 
@@ -221,6 +229,9 @@ class Leopard(object):
         if status is not self.PicovoiceStatuses.SUCCESS:
             raise self._PICOVOICE_STATUS_TO_EXCEPTION[status]()
 
+        transcript = c_transcript.value.decode('utf-8')
+        self._transcript_delete_func(c_transcript)
+
         words = list()
         for i in range(num_words.value):
             word = self.Word(
@@ -230,10 +241,9 @@ class Leopard(object):
                 confidence=c_words[i].confidence)
             words.append(word)
 
-        if num_words.value > 0:
-            self._pv_free(c_words)
+        self._words_delete_func(c_words)
 
-        return c_transcript.value.decode('utf-8'), words
+        return transcript, words
 
     def process_file(self, audio_path: str) -> Tuple[str, Sequence[Word]]:
         """
@@ -264,6 +274,9 @@ class Leopard(object):
                     )
             raise self._PICOVOICE_STATUS_TO_EXCEPTION[status]()
 
+        transcript = c_transcript.value.decode('utf-8')
+        self._transcript_delete_func(c_transcript)
+
         words = list()
         for i in range(num_words.value):
             word = self.Word(
@@ -273,10 +286,9 @@ class Leopard(object):
                 confidence=c_words[i].confidence)
             words.append(word)
 
-        if num_words.value > 0:
-            self._pv_free(c_words)
+        self._words_delete_func(c_words)
 
-        return c_transcript.value.decode('utf-8'), words
+        return transcript, words
 
     def delete(self) -> None:
         """Releases resources acquired by Leopard."""

pvleopard/{util.py → _util.py}

@@ -1,5 +1,5 @@
 #
-# Copyright 2022 Picovoice Inc.
+# Copyright 2022-2023 Picovoice Inc.
 #
 # You may not use this file except in compliance with the license. A copy of the license is located in the "LICENSE"
 # file accompanying this source.

{pvleopard-1.1.4.dist-info → pvleopard-1.2.0.dist-info}/METADATA

@@ -1,11 +1,13 @@
 Metadata-Version: 2.1
 Name: pvleopard
-Version: 1.1.4
+Version: 1.2.0
 Summary: Leopard Speech-to-Text Engine.
 Home-page: https://github.com/Picovoice/leopard
 Author: Picovoice
 Author-email: hello@picovoice.ai
+License: UNKNOWN
 Keywords: Speech-to-Text,Speech Recognition,Voice Recognition,ASR,Automatic Speech Recognition
+Platform: UNKNOWN
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
@@ -68,7 +70,24 @@ Replace `${ACCESS_KEY}` with yours obtained from [Picovoice Console](https://con
 `${AUDIO_PATH}` to the path an audio file. Finally, when done be sure to explicitly release the resources using
 `handle.delete()`.
 
+## Language Model
+
+The Leopard Python SDK comes preloaded with a default English language model (`.pv` file). 
+Default models for other supported languages can be found in [lib/common](../../lib/common). 
+
+Create custom language models using the [Picovoice Console](https://console.picovoice.ai/). Here you can train
+language models with custom vocabulary and boost words in the existing vocabulary.
+
+Pass in the `.pv` file via the `model_path` argument:
+```python
+handle = pvleopard.create(
+    access_key='${ACCESS_KEY}',
+    model_path='${MODEL_PATH}')
+```
+
 ## Demos
 
 [pvleoparddemo](https://pypi.org/project/pvleoparddemo/) provides command-line utilities for processing audio using
 Leopard.
+
+

pvleopard-1.2.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+pvleopard/LICENSE,sha256=ZurJwSSRHw99lGaJP88vQREqtZmIABuVKd_rK7k7U70,11344
+pvleopard/__init__.py,sha256=OCI_7jgscvkzJMwT02SfB85_xOoQC8eb1e52HR_GKgo,577
+pvleopard/_factory.py,sha256=WzrCwUlU_TCXkzZKPFd0ag4sAdiuwRlpOM6HYl1M-t0,1746
+pvleopard/_leopard.py,sha256=qk9kf7aRETnbEyBOrZ7sg_ESgKm3NEow_6nnQjjl-ms,10366
+pvleopard/_util.py,sha256=blfsGbVyqTjdHaj7RmU0DEc6fxab47w7EApDWCxKML8,3061
+pvleopard/lib/common/leopard_params.pv,sha256=CBoaZ8kach9nVD-I-SJakBvbVi2EfxpiumH9Bk_DKCU,19850729
+pvleopard-1.2.0.dist-info/METADATA,sha256=c_cUFkQUw7npZTyj9bSmob4XGpDx480NWYg_XcrWhCQ,3102
+pvleopard-1.2.0.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
+pvleopard-1.2.0.dist-info/top_level.txt,sha256=DAhlor-zWSROmsQCFWDsx_IJSE62zlgJ3sE4quxhEPw,10
+pvleopard-1.2.0.dist-info/RECORD,,

pvleopard-1.1.4.dist-info/RECORD

@@ -1,18 +0,0 @@
-pvleopard/LICENSE,sha256=ZurJwSSRHw99lGaJP88vQREqtZmIABuVKd_rK7k7U70,11344
-pvleopard/__init__.py,sha256=9dNC_2TQ4YCYSkXthUBLgYy-7K8q_e4O5BHSrmw3j7c,1669
-pvleopard/leopard.py,sha256=pHsXWGHmk7RAQBccslZdoiVlb-p4NbAxuVqm1pLZzIE,9961
-pvleopard/util.py,sha256=vNvTOBiX5ZP9Gd_-vgd71EqPnY8YdPJ06muh2Smqhj0,3056
-pvleopard/lib/common/leopard_params.pv,sha256=kH9sOC_szGMkbHzSTRbmre-helqNFKXWmroAUK4FUcc,19139221
-pvleopard/lib/jetson/cortex-a57-aarch64/libpv_leopard.so,sha256=3JdoCvpp-d1Ih6cA9KE2kOQ1cAuNmJsRiX2Zm5thzEk,1274464
-pvleopard/lib/linux/x86_64/libpv_leopard.so,sha256=8FW1Ssktd9P7tgjbrkBmgAPG0zcUPaw4Q6wb3iLOzFE,1369208
-pvleopard/lib/mac/arm64/libpv_leopard.dylib,sha256=tnaN0GAIO3asFBJz6T1bCXxBVWesysY78jzNrSU9GKw,1496704
-pvleopard/lib/mac/x86_64/libpv_leopard.dylib,sha256=Tl7bDk89QjGKpvvbWIi0B-itAgjpZlu-Zf7BLFNmn7Y,1649744
-pvleopard/lib/raspberry-pi/cortex-a53/libpv_leopard.so,sha256=w066F-s2zMwRg-iBCFIAZegH0xBxvoYoS-vQ0YSJEXg,1234356
-pvleopard/lib/raspberry-pi/cortex-a53-aarch64/libpv_leopard.so,sha256=sCtOQMMO0Dvkyb_g3T9q6QU1e6uQViF33pOTLzTmx9k,1278648
-pvleopard/lib/raspberry-pi/cortex-a72/libpv_leopard.so,sha256=omvbYIrPa8dOUFe4Nnyr_AwcpQ2IwbHY7wltYGPWX8U,1246644
-pvleopard/lib/raspberry-pi/cortex-a72-aarch64/libpv_leopard.so,sha256=KgezrVHCLspnXPaBgle_qAbPO49mk-Z6pS_YldJo67Y,1266360
-pvleopard/lib/windows/amd64/libpv_leopard.dll,sha256=dWuDulgUuhJDWgTd8cJu_vCGK2CJLJES0JoRNKrrJog,1608192
-pvleopard-1.1.4.dist-info/METADATA,sha256=JpDaRWDQUK6rpJYQ8c93XQ9-fLEws_tk8-srn3VEk2A,2504
-pvleopard-1.1.4.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
-pvleopard-1.1.4.dist-info/top_level.txt,sha256=DAhlor-zWSROmsQCFWDsx_IJSE62zlgJ3sE4quxhEPw,10
-pvleopard-1.1.4.dist-info/RECORD,,