tensorneko-util 0.3.14__tar.gz → 0.3.16__tar.gz

{tensorneko_util-0.3.14 → tensorneko_util-0.3.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tensorneko_util
-Version: 0.3.14
+Version: 0.3.16
 Summary: The Utils for Library TensorNeko.
 Home-page: https://github.com/ControlNet/tensorneko
 Author: ControlNet
@@ -8,7 +8,10 @@ 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
-Keywords: deep learning,pytorch,AI
+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
@@ -16,6 +19,7 @@ Classifier: Programming Language :: Python :: 3.8
 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: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Intended Audience :: Developers
@@ -23,9 +27,3 @@ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Classifier: Topic :: Utilities
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
-License-File: LICENSE
-
-
-The independent util library for TensorNeko. This library doesn't require PyTorch as a dependency.
-
-

{tensorneko_util-0.3.14 → tensorneko_util-0.3.16}/README.md

@@ -25,8 +25,11 @@ Tensor Neural Engine Kompanion. An util library based on PyTorch and PyTorch Lig
 
 ## Install
 
+The tensorneko requires pytorch and pytorch-lightning (optional), and you can install it with below command.
+
 ```shell
-pip install tensorneko
+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.
@@ -34,11 +37,18 @@ To use the library without PyTorch and PyTorch Lightning, you can install the ut
 pip install tensorneko_util
 ```
 
-Some cpu bound functions are implemented by `pyo3`, and you can install the optimized version with below command.
+Some cpu bound functions are implemented by rust-based `pyo3`, and you can install the optimized version with below command.
 ```shell
 pip install tensorneko_lib
 ```
 
+Some CLI tools are provided in the `tensorneko_tool` package, and you can install it with below command.
+```shell
+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
 
 Build an MLP with linear layers. The activation and normalization will be placed in the hidden layers.
@@ -481,7 +491,7 @@ This library provides event bus based reactive tools. The API integrates the Pyt
 # useful decorators for default event bus
 from tensorneko.util import subscribe
 # Event base type
-from tensorneko.util import Event
+from tensorneko.util import Event, EventBus
 
 class LogEvent(Event):
     def __init__(self, message: str):
@@ -511,6 +521,7 @@ if __name__ == '__main__':
     # emit an event, and then the event handler will be invoked
     # The sequential order is not guaranteed
     LogEvent("Hello world!")
+    EventBus.default.wait()  # it's not blocking, need to call wait manually before exit.
     # one possible output:
     # Hello world! in another thread
     # Hello world! async
@@ -646,3 +657,13 @@ Functions list (in `tensorneko`):
 - `with_printed_shape`
 - `is_bad_num`
 - `count_parameters`
+
+## TensorNeko Tools
+
+Some CLI tools are provided in the `tensorneko_tool` package.
+
+The `gotify` can send a message to the Gotify server, with the environment variables `GOTIFY_URL` and `GOTIFY_TOKEN` set.
+
+```shell
+tensorneko gotify "Script finished!"
+```

{tensorneko_util-0.3.14 → tensorneko_util-0.3.16}/setup.py

@@ -5,9 +5,13 @@ with open("README.md", "r") as file:
     long_description = file.read()
 
 requirements = []
+extra_requirements = []
 with open("requirements.txt", "r") as file:
     for line in file:
-        requirements.append(line.strip())
+        if line.startswith("lightning") or line.startswith("tensorboard"):
+            extra_requirements.append(line.strip())
+        else:
+            requirements.append(line.strip())
 
 
 version = init.read_version()
@@ -27,7 +31,7 @@ setuptools.setup(
         "Bug Tracker": "https://github.com/ControlNet/tensorneko/issues",
         "Source Code": "https://github.com/ControlNet/tensorneko",
     },
-    keywords=["deep learning", "pytorch", "AI"],
+    keywords=["deep learning", "pytorch", "AI", "data processing"],
     package_dir={"": "src"},
     packages=setuptools.find_packages(where="src", include=["tensorneko", "tensorneko.*"]),
     package_data={
@@ -37,12 +41,16 @@ setuptools.setup(
     },
     python_requires=">=3.8",
     install_requires=requirements,
+    extras_require={
+        "lightning": extra_requirements
+    },
     classifiers=[
         "Programming Language :: Python :: 3",
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
         "Intended Audience :: Developers",

{tensorneko_util-0.3.14 → tensorneko_util-0.3.16}/setup_util.py

@@ -26,7 +26,7 @@ setuptools.setup(
         "Bug Tracker": "https://github.com/ControlNet/tensorneko/issues",
         "Source Code": "https://github.com/ControlNet/tensorneko",
     },
-    keywords=["deep learning", "pytorch", "AI"],
+    keywords=["deep learning", "pytorch", "AI", "data processing"],
     package_dir={"": "src"},
     packages=setuptools.find_packages(where="src", include=["tensorneko_util", "tensorneko_util.*"]),
     package_data={
@@ -46,6 +46,7 @@ setuptools.setup(
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
         "Intended Audience :: Developers",

{tensorneko_util-0.3.14 → tensorneko_util-0.3.16}/src/tensorneko_util/__init__.py

@@ -7,6 +7,7 @@ from . import visualization
 from . import preprocess
 from . import io
 from . import debug
+from . import msg
 from .io import read, write
 
 __all__ = [
@@ -16,9 +17,15 @@ __all__ = [
     "preprocess",
     "io",
     "debug",
+    "msg",
     "read",
     "write",
 ]
 
+try:
+    from . import _rich
+except ImportError:
+    pass
+
 with open(os.path.join(dirname(__file__), "version.txt"), "r", encoding="UTF-8") as file:
     __version__ = file.read()

tensorneko_util-0.3.16/src/tensorneko_util/_rich.py

@@ -0,0 +1,2 @@
+from rich.traceback import install
+install(show_locals=False)

{tensorneko_util-0.3.14 → tensorneko_util-0.3.16}/src/tensorneko_util/io/json/json_writer.py

@@ -14,9 +14,10 @@ class JsonWriter:
                 json.dump(obj, file, indent=indent, ensure_ascii=ensure_ascii)
         else:
             import orjson
-            with open(path, "w", encoding=encoding) as file:
+            with open(path, "wb") as file:
                 if indent == 4:
-                    option = orjson.OPT_INDENT_4
+                    warnings.warn("orjson does not support indent 4, will use indent 2 instead.")
+                    option = orjson.OPT_INDENT_2
                 elif indent == 2:
                     option = orjson.OPT_INDENT_2
                 else:

{tensorneko_util-0.3.14 → tensorneko_util-0.3.16}/src/tensorneko_util/io/video/video_writer.py

@@ -1,5 +1,6 @@
 import pathlib
 import warnings
+from subprocess import Popen
 from typing import Optional, Union
 
 import numpy as np
@@ -116,7 +117,7 @@ class VideoWriter:
             if not VisualLib.ffmpeg_available():
                 raise ValueError("FFMPEG is not installed.")
             import ffmpeg
-            pipe = ffmpeg.input("pipe:", format="rawvideo", pix_fmt="rgb24", s=f"{video.shape[2]}x{video.shape[1]}") \
+            pipe: Popen = ffmpeg.input("pipe:", format="rawvideo", pix_fmt="rgb24", s=f"{video.shape[2]}x{video.shape[1]}") \
                 .output(path, format=ext[1:], pix_fmt="rgb24", r=video_fps) \
                 .overwrite_output() \
                 .run_async(pipe_stdin=True)

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

@@ -0,0 +1,3 @@
+from .gotify import push_gotify
+
+__all__ = ["push_gotify"]

tensorneko_util-0.3.16/src/tensorneko_util/msg/gotify.py

@@ -0,0 +1,48 @@
+import json
+import os
+import socket
+import urllib.request
+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,
+    priority: int = 0
+):
+    """
+    Push a message to a Gotify server.
+
+    Args:
+        message (``str``): The message to be sent.
+        url (``str``, optional): The URL of the Gotify server. If not provided, it will be read from the environment variable GOTIFY_URL.
+        token (``str``, optional): The token for the Gotify server. If not provided, it will be read from the environment variable GOTIFY_TOKEN.
+        title (``str``, optional): The title of the message. Default is the hostname of the machine.
+        priority (``int``, optional): The priority of the message. Default is 0.
+
+    Examples::
+
+        push_gotify("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
+
+    """
+    title = title or socket.gethostname()
+    url = url or os.environ.get("GOTIFY_URL")
+    if url is None:
+        raise ValueError("URL is not provided. Input url argument or set the environment variable GOTIFY_URL.")
+    token = token or os.environ.get("GOTIFY_TOKEN")
+    if token is None:
+        raise ValueError("Token is not provided. Input token argument or set the environment variable GOTIFY_TOKEN.")
+    url = f"{url.rstrip('/')}/message?token={token}"
+    data = json.dumps(
+        {"title": title, "message": message, "priority": priority}
+    ).encode("utf-8")
+    req = urllib.request.Request(url, data=data, method="POST", headers={
+        "Content-Type": "application/json",
+        "User-Agent": "TensorNeko"
+    })
+    try:
+        with urllib.request.urlopen(req) as res:
+            pass
+    except HTTPError as e:
+        print(e.read().decode("utf-8"))

{tensorneko_util-0.3.14 → tensorneko_util-0.3.16}/src/tensorneko_util/util/eventbus/bus.py

@@ -6,7 +6,8 @@ from abc import ABC, abstractmethod
 from concurrent.futures import wait
 from dataclasses import dataclass
 from enum import Enum
-from typing import Dict, Type, Callable, TYPE_CHECKING, Any, Coroutine, Union, Set, TypeVar
+from typing import Dict, Type, Callable, TYPE_CHECKING, Any, Coroutine, Union, Set, TypeVar, List
+from concurrent.futures import Future
 
 from ...backend.parallel import ExecutorPool, ParallelType
 
@@ -99,12 +100,7 @@ class EventBus:
         .. code-block:: python
 
             # useful decorators for default event bus
-            from tensorneko.util import (
-                subscribe, # run in the main thread
-                subscribe_thread, # run in a new thread
-                subscribe_async, # run async
-                subscribe_process # run in a new process
-            )
+            from tensorneko.util import subscribe
             # Event base type
             from tensorneko.util import Event
 
@@ -117,15 +113,15 @@ class EventBus:
             def log_information(event: LogEvent):
                 print(event.message)
 
-            @subscribe_thread
+            @subscribe.thread
             def log_information_thread(event: LogEvent):
                 print(event.message, "in another thread")
 
-            @subscribe_async
+            @subscribe.coro
             async def log_information_async(event: LogEvent):
                 print(event.message, "async")
 
-            @subscribe_process
+            @subscribe.process
             def log_information_process(event: LogEvent):
                 print(event.message, "in a new process")
 
@@ -171,6 +167,7 @@ class EventBus:
 
     def __init__(self):
         self.listeners: Dict[Type[E], Set[Listener]] = {}
+        self.futures: List[Future] = []
 
     def register(self,
         event_type: Type[E],
@@ -185,7 +182,7 @@ class EventBus:
             self.listeners[event_type] = set()
         self.listeners[event_type].add(Listener(func, func_name, emit_type))
 
-    def emit(self, event: E, blocking: bool = True) -> None:
+    def emit(self, event: E) -> None:
         event_type: Type[E] = type(event)
         if event_type in self.listeners:
             normal_listeners = set()
@@ -216,8 +213,14 @@ class EventBus:
             for listener in normal_listeners:
                 listener.func(event)
 
-            if blocking:
-                wait(futures)
+            self.futures.extend(futures)
+
+    def wait(self):
+        """
+        Wait for all the futures to be completed.
+        """
+        wait(self.futures)
+        self.futures.clear()
 
     @staticmethod
     async def emit_async(async_listeners: Set[Listener], event: E) -> None:

{tensorneko_util-0.3.14 → tensorneko_util-0.3.16}/src/tensorneko_util/util/eventbus/event.py

@@ -1,4 +1,3 @@
-from contextlib import contextmanager
 from typing import TypeVar
 
 from .bus import EventBus
@@ -9,24 +8,10 @@ class EventMeta(type):
     def __call__(cls, *args, **kwargs):
         event = super().__call__(*args, **kwargs)
         event.bus = kwargs.get("bus", EventBus.default)
-        event.bus.emit(event, blocking=_blocking_flag)
+        event.bus.emit(event)
         return event
 
 
-_blocking_flag = True
-
-
-@contextmanager
-def no_blocking():
-    """
-    Context manager to disable blocking event handler.
-    """
-    global _blocking_flag
-    _blocking_flag = False
-    yield
-    _blocking_flag = True
-
-
 class Event(metaclass=EventMeta):
     bus: EventBus
 

{tensorneko_util-0.3.14 → tensorneko_util-0.3.16}/src/tensorneko_util/util/registry.py

@@ -28,7 +28,7 @@ class Registry(Generic[T]):
     """
 
     def __init__(self):
-        self._registry: dict[str, T] = {}
+        self._registry: dict[str, Type[T]] = {}
 
     def register(self, name: str) -> Callable[[Type[T]], Type[T]]:
         def wrapper(cls):
@@ -37,7 +37,7 @@ class Registry(Generic[T]):
 
         return wrapper
 
-    def __getitem__(self, name: str) -> T:
+    def __getitem__(self, name: str) -> Type[T]:
         return self._registry[name]
 
     def items(self):

tensorneko_util-0.3.16/src/tensorneko_util/version.txt

@@ -0,0 +1 @@
+0.3.16