Metadata-Version: 2.1
Name: memodo
Version: 1.0.0
Summary: Memodo: An linear attention solution
Author: Project VsingerXiaoice Group
Author-email: alan_sudo@yeah.net
License: The Unlicense
        
        This is free and unencumbered software released into the public domain.
        
        Anyone is free to copy, modify, publish, use, compile, sell, or
        distribute this software, either in source code form or as a compiled
        binary, for any purpose, commercial or non-commercial, and by any
        means.
        
        In jurisdictions that recognize copyright laws, the author or authors
        of this software dedicate any and all copyright interest in the
        software to the public domain. We make this dedication for the benefit
        of the public at large and to the detriment of our heirs and
        successors. We intend this dedication to be an overt act of
        relinquishment in perpetuity of all present and future rights to this
        software under copyright law.
        
        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 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.
        
        For more information, please refer to <https://unlicense.org/>
Requires: torch
Description-Content-Type: text/markdown
License-File: LICENSE

# Memodo: An linear attention solution

Memodo is an linear attention solution that combining the advantages of both RWKV and DeltaNet.

# Usage

Just use `memodo.MemodoLayer`, this is an subclass of `torch.nn.Module`.

# Mechanism

Memodo use the General Delta Rule directly:
```
S -> S * diag(i) + S * a^T * b + c^T * d
return r * S
```
With Dynamic Token Shift:
```
d[t] = sigmoid(silu(lerp(x[t], x[t - 1], w1) * w2) * w3)
x[t] = lerp(x[t], x[t - 1], d[t])
```
And gated residual:
```
R -> R + Block(x) * sigmoid(silu(LayerNorm(R) * w1) * w2)
```
