deep-atomic 0.2.0__tar.gz → 0.2.2__tar.gz

deep_atomic-0.2.2/.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.21
+    hooks:
+      - id: ruff-check
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format

{deep_atomic-0.2.0 → deep_atomic-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: deep_atomic
-Version: 0.2.0
+Version: 0.2.2
 Summary: A simple deep learning framework built upon numpy only
 Author-email: Elliot Zhang <elliot_zh@proton.me>
 License: MIT
@@ -8,11 +8,12 @@ License-File: LICENSE
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Requires-Dist: numpy>=1.24.4
 Requires-Dist: pytest>=8.3.5
 Provides-Extra: dev
 Requires-Dist: black>=23.0; extra == 'dev'
+Requires-Dist: pre-commit>=4.6.0; extra == 'dev'
 Requires-Dist: pytest-cov>=4.0; extra == 'dev'
 Requires-Dist: pytest>=7.0; extra == 'dev'
 Requires-Dist: ruff>=0.1.0; extra == 'dev'
@@ -20,7 +21,7 @@ Description-Content-Type: text/markdown
 
 # Deep Atomic
 
-A simple deep learning framework built upon numpy only. Mainly for practice and learning.
+A simple deep learning framework built on NumPy only. Mainly for practice and learning.
 
 ## Usage
 
@@ -52,7 +53,7 @@ a = da.Tensor(
 
 ### Supported Operations
 
-Most essential deep‑learning operations are implemented. For those that also exist in NumPy, we follow NumPy's API conventions.
+Most essential deep-learning operations are implemented. For those that also exist in NumPy, we follow NumPy's API conventions.
 
 ```python
 a, b = da.Tensor(np.random.rand(3, 4)), da.Tensor(np.random.rand(3, 4))
@@ -69,24 +70,28 @@ c = da.log(a)
 c = da.sin(a)
 # the same for cos, tan, arcsin, arccos, arctan, sinh, cosh, tanh, arcsinh, arccosh, arctanh
 
-d = a < b                     # element-wise comparison, create a boolean tensor
+d = a < b                     # element-wise comparison, creates a boolean tensor
 e = a <= b
 c = a > b
 c = a >= b
 c = a == b
 c = a != b
-c = da.fmax(a, b)             # IMPORTANT: here da.fmax is identical to da.maximum, for simplicity. same for da.fmin / da.minimum
+c = da.fmax(a, b)             # IMPORTANT: here da.fmax is identical to da.maximum, for simplicity. Same for da.fmin / da.minimum
 c = da.maximum(a, b)
 c = da.fmin(a, b)
 c = da.minimum(a, b)
 
-c = d & e                     # element-wise and
-c = d | e                     # element-wise or
-c = d ^ e                     # element-wise xor
-c = da.logical_not(d)         # element-wise not
-c = d.all(axis=-1)            # reduction of and operation
-c = d.any(axis=-1)            # reduction of or operation
-c = da.where(d, a, b)         # return elements chosen from a or b depending on condition
+c = da.logical_and(d, e)                     # element-wise and
+c = d & e                                    # equivalence
+c = da.logical_or(d, e)                      # element-wise or
+c = d | e
+c = da.logical_xor(d, e)                     # element-wise xor
+c = d ^ e
+c = da.logical_not(d)                        # element-wise not
+c = ~d
+c = d.all(axis=-1, keepdims=False)           # logical AND reduction. axis=None, keepdims=False by default
+c = d.any(axis=-1, keepdims=False)           # logical OR reduction. axis=None, keepdims=False by default
+c = da.where(d, a, b)                        # returns elements chosen from a or b depending on condition
 
 c = da.topk(a, 2, axis=-1, largest=True)    # same as pytorch. axis=-1, largest=True by default
 
@@ -94,6 +99,7 @@ c = da.sum(a)                               # shape: (1,)
 c = da.sum(a, axis=1)                       # shape: (3,)
 c = da.sum(a, axis=1, keepdims=True)        # shape: (3, 1)
 # min, max, argmin, argmax follow the same signature
+# all reductions set axis=None, keepdims=False by default
 
 c = da.softmax(a, axis=-1, temperature=0.6) # support temperature. temperature=1 by default
 c = da.log_softmax(a, axis=-1, temperature=0.6)
@@ -114,17 +120,17 @@ c = a.tile(2, 2)                              # method‑style alternative
 
 ### Autograd
 
-Autograd is supported via computational graph.
-_Currently only support scalar source points._
+Autograd is supported via a computational graph.
+_Currently only supports scalar source points._
 
 ```python
 x = Tensor(np.random.rand(3, 4)) # requires_grad == True by default
 res = ... # some calculation related to x. res is a **scalar** result
 res.backward()
-print(res.grad) # gradient get!
+print(res.grad) # gradient computed!
 ```
 
-## Todo
+## To Do
 
 - [ ] more basic operations and their autograd
     - [x] topk
@@ -132,22 +138,29 @@ print(res.grad) # gradient get!
     - [x] gather or take_along_axis
     - [ ] scatter
     - [ ] convolution and 2d convolution
+    - [ ] pooling
+    - [ ] softmax attention
     - [ ] direct masking and indexing via `[]` syntax
     - [ ] einsum
+    - [ ] normalization
 - [ ] support backward with Vector-Jacobian Product like pytorch
-- [ ] basic neural network classes
+- [ ] basic neural network modules
 - [ ] optimizers and loss functions
+- [ ] dataset pipelines
+- [ ] save and load state dict file
 - [ ] full training test
 - [ ] benchmark with pytorch on CPU
-- [ ] attention layers and full LLM training
+- [ ] full LLM training
 - [ ] finer type annotations, comments and documentation
 
 ## Development
 
-Recommend manage dependencies using [uv](https://github.com/astral-sh/uv).
+We recommend managing dependencies with [uv](https://github.com/astral-sh/uv).
+We use [pre-commit](https://github.com/pre-commit/pre-commit) to manage hooks that help lint and format our code.
 
 ```bash
 uv sync
+pre-commit install # install pre-commit git hooks for lint and format
 ```
 
 Run tests:

{deep_atomic-0.2.0 → deep_atomic-0.2.2}/README.md

@@ -1,6 +1,6 @@
 # Deep Atomic
 
-A simple deep learning framework built upon numpy only. Mainly for practice and learning.
+A simple deep learning framework built on NumPy only. Mainly for practice and learning.
 
 ## Usage
 
@@ -32,7 +32,7 @@ a = da.Tensor(
 
 ### Supported Operations
 
-Most essential deep‑learning operations are implemented. For those that also exist in NumPy, we follow NumPy's API conventions.
+Most essential deep-learning operations are implemented. For those that also exist in NumPy, we follow NumPy's API conventions.
 
 ```python
 a, b = da.Tensor(np.random.rand(3, 4)), da.Tensor(np.random.rand(3, 4))
@@ -49,24 +49,28 @@ c = da.log(a)
 c = da.sin(a)
 # the same for cos, tan, arcsin, arccos, arctan, sinh, cosh, tanh, arcsinh, arccosh, arctanh
 
-d = a < b                     # element-wise comparison, create a boolean tensor
+d = a < b                     # element-wise comparison, creates a boolean tensor
 e = a <= b
 c = a > b
 c = a >= b
 c = a == b
 c = a != b
-c = da.fmax(a, b)             # IMPORTANT: here da.fmax is identical to da.maximum, for simplicity. same for da.fmin / da.minimum
+c = da.fmax(a, b)             # IMPORTANT: here da.fmax is identical to da.maximum, for simplicity. Same for da.fmin / da.minimum
 c = da.maximum(a, b)
 c = da.fmin(a, b)
 c = da.minimum(a, b)
 
-c = d & e                     # element-wise and
-c = d | e                     # element-wise or
-c = d ^ e                     # element-wise xor
-c = da.logical_not(d)         # element-wise not
-c = d.all(axis=-1)            # reduction of and operation
-c = d.any(axis=-1)            # reduction of or operation
-c = da.where(d, a, b)         # return elements chosen from a or b depending on condition
+c = da.logical_and(d, e)                     # element-wise and
+c = d & e                                    # equivalence
+c = da.logical_or(d, e)                      # element-wise or
+c = d | e
+c = da.logical_xor(d, e)                     # element-wise xor
+c = d ^ e
+c = da.logical_not(d)                        # element-wise not
+c = ~d
+c = d.all(axis=-1, keepdims=False)           # logical AND reduction. axis=None, keepdims=False by default
+c = d.any(axis=-1, keepdims=False)           # logical OR reduction. axis=None, keepdims=False by default
+c = da.where(d, a, b)                        # returns elements chosen from a or b depending on condition
 
 c = da.topk(a, 2, axis=-1, largest=True)    # same as pytorch. axis=-1, largest=True by default
 
@@ -74,6 +78,7 @@ c = da.sum(a)                               # shape: (1,)
 c = da.sum(a, axis=1)                       # shape: (3,)
 c = da.sum(a, axis=1, keepdims=True)        # shape: (3, 1)
 # min, max, argmin, argmax follow the same signature
+# all reductions set axis=None, keepdims=False by default
 
 c = da.softmax(a, axis=-1, temperature=0.6) # support temperature. temperature=1 by default
 c = da.log_softmax(a, axis=-1, temperature=0.6)
@@ -94,17 +99,17 @@ c = a.tile(2, 2)                              # method‑style alternative
 
 ### Autograd
 
-Autograd is supported via computational graph.
-_Currently only support scalar source points._
+Autograd is supported via a computational graph.
+_Currently only supports scalar source points._
 
 ```python
 x = Tensor(np.random.rand(3, 4)) # requires_grad == True by default
 res = ... # some calculation related to x. res is a **scalar** result
 res.backward()
-print(res.grad) # gradient get!
+print(res.grad) # gradient computed!
 ```
 
-## Todo
+## To Do
 
 - [ ] more basic operations and their autograd
     - [x] topk
@@ -112,22 +117,29 @@ print(res.grad) # gradient get!
     - [x] gather or take_along_axis
     - [ ] scatter
     - [ ] convolution and 2d convolution
+    - [ ] pooling
+    - [ ] softmax attention
     - [ ] direct masking and indexing via `[]` syntax
     - [ ] einsum
+    - [ ] normalization
 - [ ] support backward with Vector-Jacobian Product like pytorch
-- [ ] basic neural network classes
+- [ ] basic neural network modules
 - [ ] optimizers and loss functions
+- [ ] dataset pipelines
+- [ ] save and load state dict file
 - [ ] full training test
 - [ ] benchmark with pytorch on CPU
-- [ ] attention layers and full LLM training
+- [ ] full LLM training
 - [ ] finer type annotations, comments and documentation
 
 ## Development
 
-Recommend manage dependencies using [uv](https://github.com/astral-sh/uv).
+We recommend managing dependencies with [uv](https://github.com/astral-sh/uv).
+We use [pre-commit](https://github.com/pre-commit/pre-commit) to manage hooks that help lint and format our code.
 
 ```bash
 uv sync
+pre-commit install # install pre-commit git hooks for lint and format
 ```
 
 Run tests:

{deep_atomic-0.2.0 → deep_atomic-0.2.2}/pyproject.toml

@@ -4,10 +4,10 @@ build-backend = "hatchling.build"
 
 [project]
 name = "deep_atomic"
-version = "0.2.0"
+version = "0.2.2"
 description = "A simple deep learning framework built upon numpy only"
 readme = "README.md"
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 license = { text = "MIT" }
 authors = [
     { name = "Elliot Zhang", email = "elliot_zh@proton.me" }
@@ -28,6 +28,7 @@ dev = [
     "pytest-cov>=4.0",
     "black>=23.0",
     "ruff>=0.1.0",
+    "pre-commit>=4.6.0"
 ]
 
 [tool.black]
@@ -36,9 +37,14 @@ target-version = ['py38']
 
 [tool.ruff]
 line-length = 88
-lint.select = ["E", "F", "W", "I"]
+lint.select = ["I"] # currently only use isort
 lint.fixable = ["I"]
 
+[tool.ruff.lint.isort]
+known-third-party = ["numpy"]
+known-first-party = ["deep-atomic"]
+force-sort-within-sections = true
+
 [tool.pytest.ini_options]
 testpaths = ["tests"]
 python_files = "*_test.py"

{deep_atomic-0.2.0 → deep_atomic-0.2.2}/src/deep_atomic/__init__.py

@@ -1,7 +1,7 @@
 """deep-atomic - A simple deep learning framework built upon numpy only"""
 
-__version__ = "0.2.0"
+__version__ = "0.2.2"
 __author__ = "elliot_zh@proton.me"
 
-from .tensor import *
 from .op import *
+from .tensor import *