release on pypi

AIboy996 · Apr 17, 2024 · 064ba40 · 064ba40
1 parent 3ebcf77
commit 064ba40
Show file tree

Hide file tree

Showing 17 changed files with 98 additions and 3 deletions.
diff --git a/dist/npnn-0.0.1-py3-none-any.whl b/dist/npnn-0.0.1-py3-none-any.whl
diff --git a/dist/npnn-0.0.1.tar.gz b/dist/npnn-0.0.1.tar.gz
diff --git a/pyproject.toml b/pyproject.toml
@@ -12,7 +12,7 @@ requires-python = ">=3.10"
 authors = [
   { name="Yang Zhang", email="[email protected]" },
 ]
-description = "Numpy Neural Network"
+description = "NumPy Neural Network"
 readme = "readme.md"
 license = {file = "LICENSE"}
 keywords = ["numpy", "neural network", "machine learning", "autograd"]

diff --git a/readme.md b/readme.md
@@ -1,6 +1,12 @@
-# NPNN
+# [npnn](https://pypi.org/project/npnn/0.0.1/)
 > NumPy Neural Network
 
+[![PyPI - Version](https://img.shields.io/pypi/v/npnn)](https://pypi.org/project/npnn/0.0.1/)
+![PyPI - Implementation](https://img.shields.io/pypi/implementation/npnn)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/npnn)
+<!-- ![PyPI - Downloads](https://img.shields.io/pypi/dm/npnn) -->
+
+
 ## What's `npnn`?
 > `npnn` is a a torch-like Python module for **gradient descent based machine learning** implemented with NumPy. 
 

diff --git a/requirements.txt b/requirements.txt
@@ -1 +1 @@
-./npnn
+npnn
diff --git a/src/npnn.egg-info/PKG-INFO b/src/npnn.egg-info/PKG-INFO
@@ -0,0 +1,68 @@
+Metadata-Version: 2.1
+Name: npnn
+Version: 0.0.1
+Summary: NumPy Neural Network
+Author-email: Yang Zhang <[email protected]>
+License: MIT License
+
+        Copyright (c) 2024 Yang Zhang
+
+        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.
+
+Project-URL: Homepage, https://github.com/AIboy996/npnn
+Keywords: numpy,neural network,machine learning,autograd
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.10
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Provides-Extra: cuda
+Requires-Dist: cupy; extra == "cuda"
+
+# NPNN
+> NumPy Neural Network
+
+## What's `npnn`?
+> `npnn` is a a torch-like Python module for **gradient descent based machine learning** implemented with NumPy. 
+
+
+## Work with `npnn`!
+> construct a image classification neural network with npnn
+
+BTW, this is a course assignment of *DATA620004, School of Data Science, Fudan University*.
+
+### Task
+Construct and Train a neural network on [Fashion-MNIST](https://github.com/zalandoresearch/fashion-mnist) to do image classification.
+
+- Implement gradient backpropagation algorithm by hand,you can use `numpy` but **DO NOT** use `pytorch` or `tensorflow` to do autograd.
+
+- Submit source code including at least four parts: `model definition`, `training`, `parameters searching` and `testing`.
+
+### Implementation
+
+- `dataset.py`: provide Fashion MNIST dataset
+- `model.py`: model definition
+- `train.py`: model training
+- `search.py`: parameters searching
+- `test.py`: model testing
+- `utils.py`: some misc function, such as `save_mode`
diff --git a/src/npnn.egg-info/SOURCES.txt b/src/npnn.egg-info/SOURCES.txt
@@ -0,0 +1,15 @@
+LICENSE
+pyproject.toml
+readme.md
+src/npnn/__init__.py
+src/npnn/autograd.py
+src/npnn/base.py
+src/npnn/functional.py
+src/npnn/nn.py
+src/npnn/optim.py
+src/npnn/test_autograd.py
+src/npnn.egg-info/PKG-INFO
+src/npnn.egg-info/SOURCES.txt
+src/npnn.egg-info/dependency_links.txt
+src/npnn.egg-info/requires.txt
+src/npnn.egg-info/top_level.txt
diff --git a/src/npnn.egg-info/dependency_links.txt b/src/npnn.egg-info/dependency_links.txt
@@ -0,0 +1 @@
+
diff --git a/src/npnn.egg-info/requires.txt b/src/npnn.egg-info/requires.txt
@@ -0,0 +1,4 @@
+numpy
+
+[cuda]
+cupy
diff --git a/src/npnn.egg-info/top_level.txt b/src/npnn.egg-info/top_level.txt
@@ -0,0 +1 @@
+npnn
diff --git a/src/__init__.py → src/npnn/__init__.py b/src/__init__.py → src/npnn/__init__.py
diff --git a/src/autograd.py → src/npnn/autograd.py b/src/autograd.py → src/npnn/autograd.py
diff --git a/src/base.py → src/npnn/base.py b/src/base.py → src/npnn/base.py
diff --git a/src/functional.py → src/npnn/functional.py b/src/functional.py → src/npnn/functional.py
diff --git a/src/nn.py → src/npnn/nn.py b/src/nn.py → src/npnn/nn.py
diff --git a/src/optim.py → src/npnn/optim.py b/src/optim.py → src/npnn/optim.py
diff --git a/src/test_autograd.py → src/npnn/test_autograd.py b/src/test_autograd.py → src/npnn/test_autograd.py
-Original file line number
+Diff line change
@@ -0,0 +1,4 @@
+    numpy
+    [cuda]
+    cupy