tensorneko-util 0.3.20__tar.gz → 0.3.22__tar.gz

tensorneko_util-0.3.22/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 ControlNet
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{tensorneko_util-0.3.20 → tensorneko_util-0.3.22}/PKG-INFO

@@ -1,18 +1,13 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: tensorneko_util
-Version: 0.3.20
+Version: 0.3.22
 Summary: The Utils for Library TensorNeko.
 Home-page: https://github.com/ControlNet/tensorneko
 Author: ControlNet
 Author-email: smczx@hotmail.com
-License: UNKNOWN
 Project-URL: Bug Tracker, https://github.com/ControlNet/tensorneko/issues
 Project-URL: Source Code, https://github.com/ControlNet/tensorneko
-Description: 
-        The independent util library for TensorNeko. This library doesn't require PyTorch as a dependency.
-        
 Keywords: deep learning,pytorch,AI,data processing
-Platform: UNKNOWN
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
@@ -20,6 +15,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Intended Audience :: Developers
@@ -27,3 +23,21 @@ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Classifier: Topic :: Utilities
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.20.1
+Requires-Dist: einops>=0.3.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+
+The independent util library for TensorNeko. This library doesn't require PyTorch as a dependency.

{tensorneko_util-0.3.20 → tensorneko_util-0.3.22}/README.md

@@ -32,7 +32,7 @@ pip install tensorneko  # for PyTorch only
 pip install tensorneko[lightning]  # for PyTorch and Lightning
 ```
 
-To use the library without PyTorch and PyTorch Lightning, you can install the util library (support Python 3.7 ~ 3.12 with limited features) with following command.
+To use the library without PyTorch and PyTorch Lightning, you can install the util library (support Python 3.7 ~ 3.13 with limited features) with following command.
 ```shell
 pip install tensorneko_util
 ```
@@ -49,7 +49,7 @@ pipx install tensorneko_tool  # or `pip install tensorneko_tool`
 
 Then you can use the CLI tools `tensorneko` in the terminal.
 
-## Neko Layers, Modules and Architectures
+## Layers, Modules and Architectures
 
 Build an MLP with linear layers. The activation and normalization will be placed in the hidden layers.
 
@@ -138,7 +138,7 @@ print(f(torch.rand(16)).shape)
 # torch.Size([1])
 ```
 
-## Neko IO
+## IO
 
 Easily load and save different modal data.
 
@@ -188,7 +188,7 @@ neko.io.write.json("path/to/json.json", json_obj)
 Besides, the read/write for `mat` and `pickle` files is also supported.
 
 
-## Neko preprocessing
+## Preprocessing
 
 ```python
 import tensorneko as neko
@@ -215,7 +215,7 @@ if `ffmpeg` is available, you can use below ffmpeg wrappers.
 - `resample_video_fps`
 - `mp32wav`
 
-## Neko Visualization
+## Visualization
 
 ### Variable Web Watcher
 Start a web server to watch the variable status when the program (e.g. training, inference, data preprocessing) is running.
@@ -366,14 +366,14 @@ trainer = neko.NekoTrainer(log_every_n_steps=100, gpus=1, logger=model.name, pre
 trainer.fit(model, dm)
 ```
 
-## Neko Callbacks
+## Callbacks
 
 Some simple but useful pytorch-lightning callbacks are provided.
 
 - `DisplayMetricsCallback`
 - `EarlyStoppingLR`: Early stop training when learning rate reaches threshold.
 
-## Neko Notebook Helpers
+## Notebook Helpers
 Here are some helper functions to better interact with Jupyter Notebook.
 ```python
 import tensorneko as neko
@@ -385,7 +385,7 @@ neko.notebook.display.audio("path/to/audio.wav")
 neko.notebook.display.code("path/to/code.java")
 ```
 
-## Neko Debug Tools
+## Debug Tools
 
 Get the default values from `ArgumentParser` args. It's convenient to use this in the notebook.
 ```python
@@ -401,7 +401,7 @@ print(args.integers)  # [1, 2, 3]
 print(args.accumulate)  # <function sum at ...>
 ```
 
-## Neko Evaluation
+## Evaluation
 
 Some metrics function for evaluation are provided.
 
@@ -412,8 +412,36 @@ Some metrics function for evaluation are provided.
 - `ssim_video`
 - `ssim_image`
 
+## Message (Access to other services)
 
-## Neko Utilities
+### Gotify
+
+Send a message to the Gotify server.
+
+The title, URL and APP_TOKEN is the environment variable `GOTIFY_TITLE`, `GOTIFY_URL` and `GOTIFY_TOKEN`, or overwritten 
+in the function arguments.
+
+```python
+from tensorneko.msg import gotify
+gotify.push("This is a test message", "<URL>", "<APP_TOKEN>")
+# then the message will be sent to the Gotify server.
+# title = "<HOST_NAME>", message = "This is a test message", priority = 0
+```
+
+### Postgres
+
+Require the `psycopg` package. Provide one single function to execute one SQL query with a temp connection.
+
+The database URL is the environment variable `DB_URL`, or overwritten in the function arguments.
+```python
+from tensorneko.msg import postgres
+result = postgres.execute("<SQL>", "<DB_URL>")
+# also async version is provided
+result = await postgres.execute_async("<SQL>", "<DB_URL>")
+```
+
+
+## Utilities
 
 ### Misc functions
 

{tensorneko_util-0.3.20 → tensorneko_util-0.3.22}/setup.py

@@ -51,6 +51,7 @@ setuptools.setup(
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
         "Programming Language :: Python :: 3.12",
+        "Programming Language :: Python :: 3.13",
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
         "Intended Audience :: Developers",

{tensorneko_util-0.3.20 → tensorneko_util-0.3.22}/setup_util.py

@@ -47,6 +47,7 @@ setuptools.setup(
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
         "Programming Language :: Python :: 3.12",
+        "Programming Language :: Python :: 3.13",
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
         "Intended Audience :: Developers",

tensorneko_util-0.3.22/src/tensorneko_util/io/audio/audio_writer.pyi

@@ -0,0 +1,29 @@
+from typing import overload, Union
+from pathlib import Path
+
+from .audio_data import AudioData
+from ...backend.audio_lib import AudioLib
+from ...util.type import T_ARRAY
+
+
+class AudioWriter:
+
+    @classmethod
+    @overload
+    def to(cls, path: Union[str, Path], audio: AudioData, channel_first: bool = True, backend: AudioLib = None
+    ) -> None: ...
+
+    @classmethod
+    @overload
+    def to(cls, path: Union[str, Path], audio: T_ARRAY, sample_rate: int = 16000, channel_first: bool = True,
+        backend: AudioLib = None
+    ): ...
+
+    @overload
+    def __new__(cls, path: Union[str, Path], audio: AudioData, channel_first: bool = True, backend: AudioLib = None
+    ) -> None: ...
+
+    @overload
+    def __new__(cls, path: Union[str, Path], audio: T_ARRAY, sample_rate: int = 16000, channel_first: bool = True,
+        backend: AudioLib = None
+    ): ...

tensorneko_util-0.3.22/src/tensorneko_util/io/video/video_reader.pyi

@@ -0,0 +1,38 @@
+from typing import Optional, overload, Union
+from pathlib import Path
+
+from numpy import ndarray
+
+from .video_data import VideoData
+from ...backend.visual_lib import VisualLib
+
+
+class VideoReader:
+
+    @classmethod
+    def of(cls, path: Union[str, Path], channel_first: bool = True, backend: Optional[VisualLib] = None) -> VideoData:
+        ...
+
+    @classmethod
+    def with_indexes(cls, path: Union[str, Path], indexes: ndarray,
+        channel_first: bool = True, backend: Optional[VisualLib] = None
+    ) -> VideoData:
+        ...
+
+    @classmethod
+    @overload
+    def with_range(cls, path: Union[str, Path], start: int, end: int, step: int, channel_first: bool = True,
+        backend: Optional[VisualLib] = None
+    ) -> VideoData:
+        ...
+
+    @classmethod
+    @overload
+    def with_range(cls, path: Union[str, Path], end: int, channel_first: bool = True,
+        backend: Optional[VisualLib] = None
+    ) -> VideoData:
+        ...
+
+    def __new__(cls, path: Union[str, Path], channel_first: bool = True, backend: Optional[VisualLib] = None
+    ) -> VideoData:
+        ...

tensorneko_util-0.3.22/src/tensorneko_util/io/video/video_writer.pyi

@@ -0,0 +1,33 @@
+from typing import overload, Optional, Union
+from pathlib import Path
+
+from .video_data import VideoData
+from ...backend.visual_lib import VisualLib
+from ...util.type import T_ARRAY
+
+
+class VideoWriter:
+
+    @classmethod
+    @overload
+    def to(cls, path: Union[str, Path], video: VideoData, audio_codec: str = None, channel_first: bool = False,
+        backend: VisualLib = None
+    ) -> None: ...
+
+    @classmethod
+    @overload
+    def to(cls, path: Union[str, Path], video: T_ARRAY, video_fps: float, audio: T_ARRAY = None,
+        audio_fps: Optional[int] = None, audio_codec: str = None, channel_first: bool = False,
+        backend: VisualLib = None
+    ) -> None: ...
+
+    @overload
+    def __new__(cls, path: Union[str, Path], video: VideoData, audio_codec: str = None, channel_first: bool = False,
+        backend: VisualLib = None
+    ) -> None: ...
+
+    @overload
+    def __new__(cls, path: Union[str, Path], video: T_ARRAY, video_fps: float, audio: T_ARRAY = None,
+        audio_fps: Optional[int] = None, audio_codec: str = None, channel_first: bool = False,
+        backend: VisualLib = None
+    ) -> None: ...

tensorneko_util-0.3.22/src/tensorneko_util/msg/__init__.py

@@ -0,0 +1,9 @@
+from . import gotify
+
+__all__ = ["gotify"]
+
+try:
+    from . import postgres
+    __all__.append("postgres")
+except ImportError:
+    pass

{tensorneko_util-0.3.20 → tensorneko_util-0.3.22}/src/tensorneko_util/msg/gotify.py

@@ -6,7 +6,7 @@ from typing import Optional
 from urllib.error import HTTPError
 
 
-def push_gotify(message: str, url: Optional[str] = None, token: Optional[str] = None, title: Optional[str] = None,
+def push(message: str, url: Optional[str] = None, token: Optional[str] = None, title: Optional[str] = None,
     priority: int = 0
 ):
     """
@@ -21,7 +21,7 @@ def push_gotify(message: str, url: Optional[str] = None, token: Optional[str] =
 
     Examples::
 
-        push_gotify("This is a test message", "<URL>", "<APP_TOKEN>")
+        push("This is a test message", "<URL>", "<APP_TOKEN>")
         # then the message will be sent to the Gotify server.
         # title = "<HOST_NAME>", message = "This is a test message", priority = 0
 

tensorneko_util-0.3.22/src/tensorneko_util/msg/postgres.py

@@ -0,0 +1,66 @@
+import os
+from typing import Any, List, Optional, Tuple
+
+import psycopg
+
+
+def execute(sql: str, db_url: Optional[str] = None) -> Optional[List[Tuple[Any, ...]]]:
+    """
+    Execute a PostgreSQL database SQL query.
+
+    Args:
+        sql (``str``): The SQL query to be executed.
+        db_url (``str``, optional): The URL of the PostgreSQL database. The default value is environment variable DB_URL.
+
+    Returns:
+        ``list[tuple] | None``: The result of the query. If the query is not a SELECT query, then it will return None.
+
+    Examples::
+
+        result = execute("SELECT * FROM table_name", "postgresql://user:password@localhost:5432/db_name")
+        # then the result will be a list of tuples.
+
+        execute("INSERT INTO table_name (column1, column2) VALUES (value1, value2)", "postgresql://user:password@localhost:5432/db_name")
+        # then the execute will be executed and committed.
+    """
+    db_url = db_url or os.environ.get("DB_URL")
+
+    with psycopg.Connection.connect(db_url) as conn:
+        with conn.cursor() as cur:
+            cur.execute(sql)
+            conn.commit()
+            if cur.description:
+                return cur.fetchall()
+            return None
+
+
+async def execute_async(sql: str, db_url: Optional[str] = None) -> Optional[List[Tuple[Any, ...]]]:
+    """
+    Execute a PostgreSQL database SQL query with async.
+
+    Args:
+        sql (``str``): The SQL query to be executed.
+        db_url (``str``, optional): The URL of the PostgreSQL database. The default value is environment variable DB_URL.
+
+    Returns:
+        ``list[tuple] | None``: The result of the query. If the query is not a SELECT query, then it will return None.
+
+    Examples::
+
+        result = await execute_async("SELECT * FROM table_name", "postgresql://user:password@localhost:5432/db_name")
+        # then the result will be a list of tuples.
+
+        await execute_async("INSERT INTO table_name (column1, column2) VALUES (value1, value2)")
+        # then the execute will be executed
+    """
+    db_url = db_url or os.environ.get("DB_URL")
+
+    if db_url is None:
+        raise ValueError("DB_URL environment variable is not set.")
+
+    async with await psycopg.AsyncConnection.connect(db_url, autocommit=True) as conn:
+        async with conn.cursor() as cur:
+            await cur.execute(sql)
+            if cur.description:
+                return await cur.fetchall()
+            return None

tensorneko_util-0.3.22/src/tensorneko_util/preprocess/crop.pyi

@@ -0,0 +1,15 @@
+from typing import overload, Union
+
+from numpy import ndarray
+
+
+@overload
+def crop_with_padding(image: ndarray, x1: int, x2: int, y1: int, y2: int, pad_value: Union[int, float] = 0.,
+    batch: bool = False
+) -> ndarray: ...
+
+
+@overload
+def crop_with_padding(image: ndarray, x1: ndarray, x2: ndarray, y1: ndarray, y2: ndarray,
+    pad_value: Union[int, float] = 0., batch: bool = False
+) -> ndarray: ...

tensorneko_util-0.3.22/src/tensorneko_util/util/dispatched_misc.pyi

@@ -0,0 +1,23 @@
+from typing import overload, List
+
+from numpy import ndarray
+
+
+@overload
+def sparse2binary(x: ndarray, length: int = None) -> ndarray:
+    ...
+
+
+@overload
+def sparse2binary(x: List[int], length: int = None) -> List[int]:
+    ...
+
+
+@overload
+def binary2sparse(x: ndarray) -> ndarray:
+    ...
+
+
+@overload
+def binary2sparse(x: List[int]) -> List[int]:
+    ...

tensorneko_util-0.3.22/src/tensorneko_util/util/ref.pyi

@@ -0,0 +1,38 @@
+from __future__ import annotations
+
+from typing import Generic, overload
+
+from .type import P
+
+
+class Ref(Generic[P]):
+    value: P
+    @overload
+    def __new__(cls, value: str) -> StringRef: ...
+    @overload
+    def __new__(cls, value: int) -> IntRef: ...
+    @overload
+    def __new__(cls, value: float) -> FloatRef: ...
+    @overload
+    def __new__(cls, value: bool) -> BoolRef: ...
+
+class StringRef(Ref[str]):
+    def __str__(self) -> str: ...
+
+class IntRef(Ref[int]):
+    def __int__(self) -> int: ...
+
+class FloatRef(Ref[float]):
+    def __float__(self) -> float: ...
+
+class BoolRef(Ref[bool]):
+    def __bool__(self) -> bool: ...
+
+@overload
+def ref(value: str) -> StringRef: ...
+@overload
+def ref(value: int) -> IntRef: ...
+@overload
+def ref(value: float) -> FloatRef: ...
+@overload
+def ref(value: bool) -> BoolRef: ...

tensorneko_util-0.3.22/src/tensorneko_util/version.txt

@@ -0,0 +1 @@
+0.3.22