x-mlps-pytorch 0.0.7__tar.gz

x_mlps_pytorch-0.0.7/.github/workflows/build.yml

@@ -0,0 +1,14 @@
+name: Build with Rye
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Python
+        uses: actions/setup-python@v4
+      - name: Install the latest version of rye
+        uses: eifinger/setup-rye@v2
+      - name: Build with Rye
+        run: rye build

x_mlps_pytorch-0.0.7/.github/workflows/python-publish.yml

@@ -0,0 +1,36 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

x_mlps_pytorch-0.0.7/.github/workflows/test.yml

@@ -0,0 +1,19 @@
+name: Tests the examples in README
+on: push
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Python
+        uses: actions/setup-python@v4
+      - name: Install the latest version of rye
+        uses: eifinger/setup-rye@v2
+      - name: Use UV instead of pip
+        run: rye config --set-bool behavior.use-uv=true
+      - name: Install dependencies
+        run: |
+          pip install .[test]
+      - name: Run pytest
+        run: pytest tests

x_mlps_pytorch-0.0.7/.gitignore

@@ -0,0 +1,174 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc

x_mlps_pytorch-0.0.7/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Phil Wang
+
+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.

x_mlps_pytorch-0.0.7/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: x-mlps-pytorch
+Version: 0.0.7
+Summary: A collection of MLPs / Feedforwards
+Project-URL: Homepage, https://pypi.org/project/x-mlps/
+Project-URL: Repository, https://github.com/lucidrains/x-mlps
+Author-email: Phil Wang <lucidrains@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2025 Phil Wang
+        
+        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.
+License-File: LICENSE
+Keywords: artificial intelligence,deep learning,feedforwards,mlps
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.8
+Requires-Dist: einops>=0.8.0
+Requires-Dist: torch>=2.4
+Provides-Extra: test
+Requires-Dist: pytest; extra == 'test'
+Description-Content-Type: text/markdown
+
+## x-mlps
+
+Just a repository that will house MLPs, from garden variety to the exotic, so as to avoid having to reimplement them again and again for different projects (especially RL)
+
+Will also be the repository I use for testing out [Jules](https://jules.google.com/) and other AI assisted tools.
+
+
+## Install
+
+```bash
+$ pip install x-mlps-pytorch
+```
+
+## Usage
+
+```python
+import torch
+from x_mlps import MLP
+
+actor = MLP(10, 16, 5)
+
+critic = MLP(10, 32, 16, 1)
+
+state = torch.randn(10)
+
+action_logits = actor(state) # (5,)
+
+values = critic(state) # (1,)
+```

x_mlps_pytorch-0.0.7/README.md

@@ -0,0 +1,29 @@
+## x-mlps
+
+Just a repository that will house MLPs, from garden variety to the exotic, so as to avoid having to reimplement them again and again for different projects (especially RL)
+
+Will also be the repository I use for testing out [Jules](https://jules.google.com/) and other AI assisted tools.
+
+
+## Install
+
+```bash
+$ pip install x-mlps-pytorch
+```
+
+## Usage
+
+```python
+import torch
+from x_mlps import MLP
+
+actor = MLP(10, 16, 5)
+
+critic = MLP(10, 32, 16, 1)
+
+state = torch.randn(10)
+
+action_logits = actor(state) # (5,)
+
+values = critic(state) # (1,)
+```

x_mlps_pytorch-0.0.7/pyproject.toml

@@ -0,0 +1,52 @@
+[project]
+name = "x-mlps-pytorch"
+version = "0.0.7"
+description = "A collection of MLPs / Feedforwards"
+authors = [
+    { name = "Phil Wang", email = "lucidrains@gmail.com" }
+]
+readme = "README.md"
+requires-python = ">= 3.8"
+license = { file = "LICENSE" }
+keywords = [
+    'artificial intelligence',
+    'deep learning',
+    'mlps',
+    'feedforwards'
+  ]
+classifiers=[
+    'Development Status :: 4 - Beta',
+    'Intended Audience :: Developers',
+    'Topic :: Scientific/Engineering :: Artificial Intelligence',
+    'License :: OSI Approved :: MIT License',
+    'Programming Language :: Python :: 3.8',
+  ]
+
+dependencies = [
+    'einops>=0.8.0',
+    'torch>=2.4',
+]
+
+[project.urls]
+Homepage = "https://pypi.org/project/x-mlps/"
+Repository = "https://github.com/lucidrains/x-mlps"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project.optional-dependencies]
+test = [
+    "pytest",
+]
+
+[tool.pytest.ini_options]
+pythonpath = [
+  "."
+]
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.hatch.build.targets.wheel]
+packages = ["x_mlps"]

x_mlps_pytorch-0.0.7/tests/test_ff.py

@@ -0,0 +1,11 @@
+import pytest
+import torch
+
+def test_ff():
+    from x_mlps_pytorch.ff import Feedforwards
+
+    mlp = Feedforwards(256, 4)
+
+    x = torch.randn(7, 3, 256)
+
+    assert mlp(x).shape == x.shape

x_mlps_pytorch-0.0.7/tests/test_mlps.py

@@ -0,0 +1,29 @@
+import pytest
+import torch
+
+def test_mlp():
+    from x_mlps_pytorch.mlp import MLP
+
+    mlp = MLP(256, 128, 64)
+
+    x = torch.randn(7, 3, 256)
+
+    assert mlp(x).shape == (7, 3, 64)
+
+# with depth
+
+def test_create_mlp():
+    from x_mlps_pytorch.mlp import create_mlp
+
+    mlp = create_mlp(
+        dim = 128,
+        dim_in = 256,
+        dim_out = 64,
+        depth = 4
+    )
+
+    # same as MLP(256, 128, 128, 128, 128, 64)
+
+    x = torch.randn(7, 3, 256)
+
+    assert mlp(x).shape == (7, 3, 64)

x_mlps_pytorch-0.0.7/x_mlps_pytorch/__init__.py

@@ -0,0 +1,7 @@
+from x_mlps_pytorch.mlp import (
+    MLP
+)
+
+from x_mlps_pytorch.ff import (
+    Feedforwards
+)

x_mlps_pytorch-0.0.7/x_mlps_pytorch/ff.py

@@ -0,0 +1,47 @@
+import torch
+from torch import nn
+from torch.nn import Module, ModuleList
+
+# main class
+
+class Feedforwards(Module):
+
+    def __init__(
+        self,
+        dim,
+        depth,
+        *,
+        activation = nn.GELU(),
+        bias = True,
+        expansion_factor = 4.,
+    ):
+        super().__init__()
+
+        layers = []
+
+        dim_hidden = int(dim * expansion_factor)
+
+        # layers
+
+        for _ in range(depth):
+
+            layer = nn.Sequential(
+                nn.RMSNorm(dim),
+                nn.Linear(dim, dim_hidden, bias = bias),
+                activation,
+                nn.Linear(dim_hidden, dim, bias = bias)
+            )
+
+            layers.append(layer)
+
+        self.layers = ModuleList(layers)
+
+    def forward(
+        self,
+        x
+    ):
+
+        for layer in self.layers:
+            x = layer(x) + x
+
+        return x

x_mlps_pytorch-0.0.7/x_mlps_pytorch/mlp.py

@@ -0,0 +1,73 @@
+import torch
+from torch import nn
+from torch.nn import Module, ModuleList
+
+# functions
+
+def exists(v):
+    return v is not None
+
+# main class
+
+class MLP(Module):
+    def __init__(
+        self,
+        *dims,
+        activation = nn.ReLU(),
+        bias = True
+    ):
+        super().__init__()
+        assert len(dims) > 1, f'must have more than 1 layer'
+
+        layers = []
+
+        # input output dimension pairs
+
+        dim_in_out = tuple(zip(dims[:-1], dims[1:]))
+
+        # layers
+
+        for i, (dim_in, dim_out) in enumerate(dim_in_out, start = 1):
+            is_last = i == len(dim_in_out)
+
+            layer = nn.Linear(dim_in, dim_out, bias = bias)
+
+            # if not last, add an activation after each linear layer
+
+            if not is_last:
+                layer = nn.Sequential(layer, activation)
+
+            layers.append(layer)
+
+        self.layers = ModuleList(layers)
+
+    def forward(
+        self,
+        x
+    ):
+
+        for layer in self.layers:
+            x = layer(x)
+
+        return x
+
+# factory function
+
+def create_mlp(
+    dim,
+    depth,
+    *,
+    dim_in = None,
+    dim_out = None,
+    **mlp_kwargs
+):
+    dims = (dim,) * depth
+
+    if exists(dim_in):
+        dims = (dim_in, *dims)
+
+    if exists(dim_out):
+        dims = (*dims, dim_out)
+
+    return MLP(*dims, **mlp_kwargs)
+