cdxcore 0.1.50__tar.gz

cdxcore-0.1.50/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Hans Buehler
+
+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.

cdxcore-0.1.50/PKG-INFO

@@ -0,0 +1,152 @@
+Metadata-Version: 2.4
+Name: cdxcore
+Version: 0.1.50
+Summary: Basic Python Tools; upgraded cdxbasics
+Author-email: Hans Buehler <github@buehler.london>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/hansbuehler/cdxcore
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: matplotlib
+Requires-Dist: sortedcontainers
+Requires-Dist: psutil
+Requires-Dist: polars
+Requires-Dist: jsonpickle
+Requires-Dist: numba
+Requires-Dist: joblib
+Requires-Dist: blosc
+Requires-Dist: mkdocstrings[python]>=0.18
+Dynamic: license-file
+
+# cdxcore documentation
+
+This module contains a number of lightweight tools, developed for managing data analytics and machine learning projects.
+
+Install using:
+
+```bash
+pip install -U cdxcore
+```
+
+Documentation can be found here: <https://quantitative-research.de/docs/cdxcore>.
+
+## Highlights
+
+- **Dynamic plotting**: simple live/animated plots built on Matplotlib.
+- **Config management**: validated, discoverable configurations with automatic help.
+- **Versioning & caching**: code-versioned I/O and reproducible hashing for pipelines.
+- **PrettyObject**: dictionary-like objects that allow attribute access.
+- **Utilities**: formatting helpers, binary I/O, shared-memory arrays, and more.
+
+## Main Functionality
+
+- [`cdxcore.dynaplot`](https://quantitative-research.de/docs/cdxcore/api/generated/cdxcore.dynaplot.html) is a framework for
+  simple **dynamic graphs** with `matplotlib`. It has a simple methodology for
+  animated updates for graphs (e.g. during training runs), and allows generation of plot layouts without knowing upfront
+  the number of plots (e.g. for plotting a list of features).
+
+  ![Aninmated 3D plot](https://quantitative-research.de/docs/cdxcore/_static/dynaplot3D.gif)
+  
+- [`cdxcore.config`](https://quantitative-research.de/docs/cdxcore/api/generated/cdxcore.config.html) allows **robust management of configurations**. It automates help, validation checking,
+  and detects misspelled configuration arguments.
+
+  ```python
+  from cdxcore.config import Config, Int, Float
+
+  class Network(object):
+      def __init__( self, config ):
+          self.depth      = config("depth", 1, Int>0, "Depth of the network")
+          self.width      = config("width", 1, Int>0, "Width of the network")
+          self.activation = config("activation", "selu", str, "Activation function")
+          config.done() # see below
+
+  config = Config()
+  config.network.depth         = 10
+  config.network.width         = 100
+  config.network.activation    = 'relu'
+
+  network = Network(config.network)
+  config.done()
+  ```
+
+- [`cdxcore.subdir`](https://quantitative-research.de/docs/cdxcore/api/generated/cdxcore.subdir.html) wraps various file and directory functions into convenient objects. Useful if files have
+  common extensions.
+
+  ```python
+  from cdxcore.subdir import SubDir
+  import numpy as np
+  root   = SubDir("!")   # current temp directory
+  subdir = root("test")  # sub-directory 'test'
+  subdir.write("data", np.zeros((10,2)))
+  data   = subdir.read("data")
+  ```
+
+-  **Caching:** ``SubDir`` supports code-versioned file i/o which is used by [`@cdxcore.subdir.SubDir.cache`](file:///C:/Users/hans/OneDrive/Python3/packages/cdxcore/docs/build/html/api/generated/cdxcore.subdir.html#cdxcore.subdir.SubDir.cache)
+  for an efficient code-versioned caching protocol for functions and objects:
+
+  ```python
+  from cdxcore.subdir import SubDir
+  cache   = SubDir("!/.cache;*.bin")
+
+  @cache.cache("0.1")
+  def f(x,y):
+     return x*y
+
+  _ = f(1,2)    # function gets computed and the result cached
+  _ = f(1,2)    # restore result from cache
+  _ = f(2,2)    # different parameters: compute and store result
+  ```
+
+- **Code versioning** is implemented in [`cdxcore.version`](https://quantitative-research.de/docs/cdxcore/api/generated/cdxcore.version.html):
+
+  ```python
+  from cdxbasics.version import version
+
+  @version("0.0.1")
+  def f(x):
+      return x
+
+  print( f.version.full )   # -> 0.0.1
+  ```
+
+- **Hashing** (which is used for caching above) is implemented in [`cdxcore.uniquehash`](https://quantitative-research.de/docs/cdxcore/api/generated/cdxcore.uniquehash.html):
+
+  ```python
+  class A(object):
+      def __init__(self, x):
+          self.x = x
+          self._y = x*2  # protected member will not be hashed by default
+
+  from cdxcore.uniquehash import UniqueHash
+  uniqueHash = UniqueHash(length=12)
+  a = A(2)
+  print( uniqueHash(a) ) # --> "2d1dc3767730"
+  ```
+
+- [`cdxcore.pretty`](https://quantitative-research.de/docs/cdxcore/api/generated/cdxcore.pretty.html) provides a ``PrettyObject`` class whose objects operate like dictionaries.
+  This is for users who prefer attribute ``.`` notation over item access when building structured output.
+
+  ```python
+  from cdxbasics.prettydict import PrettyObject
+  pdct = PrettyObject(z=1)
+
+  pdct.num_samples = 1000
+  pdct.num_batches = 100
+  pdct.method = "signature"
+  ```
+
+## General purpose utilities
+
+- [`cdxcore.verbose`](https://quantitative-research.de/docs/cdxcore/api/generated/cdxcore.verbose.html) provides user-controllable context output for providing progress updates to users.
+
+- [`cdxcore.util`](https://quantitative-research.de/docs/cdxcore/api/generated/cdxcore.util.html) offers a number of utility functions such as standard formatting for dates, big numbers, lists,
+  dictionaries etc.
+
+- [`cdxcore.npio`](https://quantitative-research.de/docs/cdxcore/api/generated/cdxcore.npio.html) provides a low level binary i/o interface for numpy files.
+
+- [`cdxcore.npshm`](https://quantitative-research.de/docs/cdxcore/api/generated/cdxcore.npshm.html) provides shared memory numpy arrays.

cdxcore-0.1.50/README.md

@@ -0,0 +1,127 @@
+# cdxcore documentation
+
+This module contains a number of lightweight tools, developed for managing data analytics and machine learning projects.
+
+Install using:
+
+```bash
+pip install -U cdxcore
+```
+
+Documentation can be found here: <https://quantitative-research.de/docs/cdxcore>.
+
+## Highlights
+
+- **Dynamic plotting**: simple live/animated plots built on Matplotlib.
+- **Config management**: validated, discoverable configurations with automatic help.
+- **Versioning & caching**: code-versioned I/O and reproducible hashing for pipelines.
+- **PrettyObject**: dictionary-like objects that allow attribute access.
+- **Utilities**: formatting helpers, binary I/O, shared-memory arrays, and more.
+
+## Main Functionality
+
+- [`cdxcore.dynaplot`](https://quantitative-research.de/docs/cdxcore/api/generated/cdxcore.dynaplot.html) is a framework for
+  simple **dynamic graphs** with `matplotlib`. It has a simple methodology for
+  animated updates for graphs (e.g. during training runs), and allows generation of plot layouts without knowing upfront
+  the number of plots (e.g. for plotting a list of features).
+
+  ![Aninmated 3D plot](https://quantitative-research.de/docs/cdxcore/_static/dynaplot3D.gif)
+  
+- [`cdxcore.config`](https://quantitative-research.de/docs/cdxcore/api/generated/cdxcore.config.html) allows **robust management of configurations**. It automates help, validation checking,
+  and detects misspelled configuration arguments.
+
+  ```python
+  from cdxcore.config import Config, Int, Float
+
+  class Network(object):
+      def __init__( self, config ):
+          self.depth      = config("depth", 1, Int>0, "Depth of the network")
+          self.width      = config("width", 1, Int>0, "Width of the network")
+          self.activation = config("activation", "selu", str, "Activation function")
+          config.done() # see below
+
+  config = Config()
+  config.network.depth         = 10
+  config.network.width         = 100
+  config.network.activation    = 'relu'
+
+  network = Network(config.network)
+  config.done()
+  ```
+
+- [`cdxcore.subdir`](https://quantitative-research.de/docs/cdxcore/api/generated/cdxcore.subdir.html) wraps various file and directory functions into convenient objects. Useful if files have
+  common extensions.
+
+  ```python
+  from cdxcore.subdir import SubDir
+  import numpy as np
+  root   = SubDir("!")   # current temp directory
+  subdir = root("test")  # sub-directory 'test'
+  subdir.write("data", np.zeros((10,2)))
+  data   = subdir.read("data")
+  ```
+
+-  **Caching:** ``SubDir`` supports code-versioned file i/o which is used by [`@cdxcore.subdir.SubDir.cache`](file:///C:/Users/hans/OneDrive/Python3/packages/cdxcore/docs/build/html/api/generated/cdxcore.subdir.html#cdxcore.subdir.SubDir.cache)
+  for an efficient code-versioned caching protocol for functions and objects:
+
+  ```python
+  from cdxcore.subdir import SubDir
+  cache   = SubDir("!/.cache;*.bin")
+
+  @cache.cache("0.1")
+  def f(x,y):
+     return x*y
+
+  _ = f(1,2)    # function gets computed and the result cached
+  _ = f(1,2)    # restore result from cache
+  _ = f(2,2)    # different parameters: compute and store result
+  ```
+
+- **Code versioning** is implemented in [`cdxcore.version`](https://quantitative-research.de/docs/cdxcore/api/generated/cdxcore.version.html):
+
+  ```python
+  from cdxbasics.version import version
+
+  @version("0.0.1")
+  def f(x):
+      return x
+
+  print( f.version.full )   # -> 0.0.1
+  ```
+
+- **Hashing** (which is used for caching above) is implemented in [`cdxcore.uniquehash`](https://quantitative-research.de/docs/cdxcore/api/generated/cdxcore.uniquehash.html):
+
+  ```python
+  class A(object):
+      def __init__(self, x):
+          self.x = x
+          self._y = x*2  # protected member will not be hashed by default
+
+  from cdxcore.uniquehash import UniqueHash
+  uniqueHash = UniqueHash(length=12)
+  a = A(2)
+  print( uniqueHash(a) ) # --> "2d1dc3767730"
+  ```
+
+- [`cdxcore.pretty`](https://quantitative-research.de/docs/cdxcore/api/generated/cdxcore.pretty.html) provides a ``PrettyObject`` class whose objects operate like dictionaries.
+  This is for users who prefer attribute ``.`` notation over item access when building structured output.
+
+  ```python
+  from cdxbasics.prettydict import PrettyObject
+  pdct = PrettyObject(z=1)
+
+  pdct.num_samples = 1000
+  pdct.num_batches = 100
+  pdct.method = "signature"
+  ```
+
+## General purpose utilities
+
+- [`cdxcore.verbose`](https://quantitative-research.de/docs/cdxcore/api/generated/cdxcore.verbose.html) provides user-controllable context output for providing progress updates to users.
+
+- [`cdxcore.util`](https://quantitative-research.de/docs/cdxcore/api/generated/cdxcore.util.html) offers a number of utility functions such as standard formatting for dates, big numbers, lists,
+  dictionaries etc.
+
+- [`cdxcore.npio`](https://quantitative-research.de/docs/cdxcore/api/generated/cdxcore.npio.html) provides a low level binary i/o interface for numpy files.
+
+- [`cdxcore.npshm`](https://quantitative-research.de/docs/cdxcore/api/generated/cdxcore.npshm.html) provides shared memory numpy arrays.

cdxcore-0.1.50/cdxcore/__init__.py

@@ -0,0 +1,7 @@
+# -*- coding: utf-8 -*-
+"""
+Created on June 2022
+@author: hansb
+"""
+
+__version__ = "0.1.50"  # auto-updated by setup.py