├── .github └── workflows │ └── python-publish.yml ├── .gitignore ├── LICENSE ├── README.md ├── remixer.png ├── remixer_pytorch ├── __init__.py └── remixer_pytorch.py └── setup.py /.github/workflows/python-publish.yml: -------------------------------------------------------------------------------- 1 | # This workflow will upload a Python Package using Twine when a release is created 2 | # For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries 3 | 4 | # This workflow uses actions that are not certified by GitHub. 5 | # They are provided by a third-party and are governed by 6 | # separate terms of service, privacy policy, and support 7 | # documentation. 8 | 9 | name: Upload Python Package 10 | 11 | on: 12 | release: 13 | types: [published] 14 | 15 | jobs: 16 | deploy: 17 | 18 | runs-on: ubuntu-latest 19 | 20 | steps: 21 | - uses: actions/checkout@v2 22 | - name: Set up Python 23 | uses: actions/setup-python@v2 24 | with: 25 | python-version: '3.x' 26 | - name: Install dependencies 27 | run: | 28 | python -m pip install --upgrade pip 29 | pip install build 30 | - name: Build package 31 | run: python -m build 32 | - name: Publish package 33 | uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29 34 | with: 35 | user: __token__ 36 | password: ${{ secrets.PYPI_API_TOKEN }} 37 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2021 Phil Wang 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | ## Remixer - Pytorch 4 | 5 | Implementation of the Remixer Block from the Remixer paper, in Pytorch. It claims that substituting the feedforwards in transformers with sequence wide mixing followed by multiplication and subtraction leads to better language understanding results. 6 | 7 | 8 | ## Install 9 | 10 | ```bash 11 | $ pip install remixer-pytorch 12 | ``` 13 | 14 | ## Usage 15 | 16 | ```python 17 | import torch 18 | from remixer_pytorch import RemixerBlock 19 | 20 | block = RemixerBlock( 21 | dim = 512, 22 | seq_len = 1024 23 | ) 24 | 25 | x = torch.randn(1, 1024, 512) 26 | block(x) # (1, 1024, 512) 27 | ``` 28 | 29 | ## Citations 30 | 31 | ```bibtex 32 | @inproceedings{anonymous, 33 | title = {Remixers: A Mixer-Transformer Architecture with Compositional Operators for Natural Language Understanding }, 34 | author = {Anonymous}, 35 | year = {2021}, 36 | url = {https://openreview.net/forum?id=9FHQHJnRtfL} 37 | } 38 | ``` 39 | -------------------------------------------------------------------------------- /remixer.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lucidrains/remixer-pytorch/9dcb08b0aca709909290e5c4696c96ba69cff387/remixer.png -------------------------------------------------------------------------------- /remixer_pytorch/__init__.py: -------------------------------------------------------------------------------- 1 | from remixer_pytorch.remixer_pytorch import RemixerBlock 2 | -------------------------------------------------------------------------------- /remixer_pytorch/remixer_pytorch.py: -------------------------------------------------------------------------------- 1 | import torch 2 | import torch.nn.functional as F 3 | from torch import nn, einsum 4 | from einops import rearrange 5 | 6 | class RemixerBlock(nn.Module): 7 | def __init__( 8 | self, 9 | dim, 10 | seq_len, 11 | causal = False, 12 | bias = False 13 | ): 14 | super().__init__() 15 | self.causal = causal 16 | self.proj_in = nn.Linear(dim, 2 * dim, bias = bias) 17 | self.mixer = nn.Parameter(torch.randn(seq_len, seq_len)) 18 | self.alpha = nn.Parameter(torch.tensor(0.)) 19 | self.proj_out = nn.Linear(dim, dim, bias = bias) 20 | 21 | def forward(self, x): 22 | mixer, causal, device = self.mixer, self.causal, x.device 23 | x, gate = self.proj_in(x).chunk(2, dim = -1) 24 | x = F.gelu(gate) * x 25 | 26 | if self.causal: 27 | seq = x.shape[1] 28 | mask_value = -torch.finfo(x.dtype).max 29 | mask = torch.ones((seq, seq), device = device, dtype=torch.bool).triu(1) 30 | mixer = mixer[:seq, :seq] 31 | mixer = mixer.masked_fill(mask, mask_value) 32 | 33 | mixer = mixer.softmax(dim = -1) 34 | mixed = einsum('b n d, m n -> b m d', x, mixer) 35 | 36 | alpha = self.alpha.sigmoid() 37 | out = (x * mixed) * alpha + (x - mixed) * (1 - alpha) 38 | 39 | return self.proj_out(out) 40 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup, find_packages 2 | 3 | setup( 4 | name = 'remixer-pytorch', 5 | packages = find_packages(exclude=[]), 6 | version = '0.0.3', 7 | license='MIT', 8 | description = 'Remixer - Pytorch', 9 | author = 'Phil Wang', 10 | author_email = 'lucidrains@gmail.com', 11 | url = 'https://github.com/lucidrains/remixer-pytorch', 12 | keywords = [ 13 | 'artificial intelligence', 14 | 'transformer', 15 | 'feedforward', 16 | 'mlp-mixer' 17 | ], 18 | install_requires=[ 19 | 'einops>=0.3', 20 | 'torch>=1.6' 21 | ], 22 | classifiers=[ 23 | 'Development Status :: 4 - Beta', 24 | 'Intended Audience :: Developers', 25 | 'Topic :: Scientific/Engineering :: Artificial Intelligence', 26 | 'License :: OSI Approved :: MIT License', 27 | 'Programming Language :: Python :: 3.6', 28 | ], 29 | ) 30 | --------------------------------------------------------------------------------