Skip to content

Commit

Permalink
[CLEANUP]
Browse files Browse the repository at this point in the history
  • Loading branch information
Kye committed Mar 25, 2024
1 parent 8f256a5 commit 8276a95
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 60 deletions.
58 changes: 1 addition & 57 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,62 +1,6 @@
[![Multi-Modality](agorabanner.png)](https://discord.gg/qUtxnK2NMf)

# Python Package Template
A easy, reliable, fluid template for python packages complete with docs, testing suites, readme's, github workflows, linting and much much more


## Installation

You can install the package using pip

```bash
pip install -e .
```

# Usage
```python
print("hello world")

```



### Code Quality 🧹

- `make style` to format the code
- `make check_code_quality` to check code quality (PEP8 basically)
- `black .`
- `ruff . --fix`

### Tests 🧪

[`pytests`](https://docs.pytest.org/en/7.1.x/) is used to run our tests.

### Publish on PyPi 🚀

**Important**: Before publishing, edit `__version__` in [src/__init__](/src/__init__.py) to match the wanted new version.

```
poetry build
poetry publish
```

### CI/CD 🤖

We use [GitHub actions](https://github.com/features/actions) to automatically run tests and check code quality when a new PR is done on `main`.

On any pull request, we will check the code quality and tests.

When a new release is created, we will try to push the new code to PyPi. We use [`twine`](https://twine.readthedocs.io/en/stable/) to make our life easier.

The **correct steps** to create a new realease are the following:
- edit `__version__` in [src/__init__](/src/__init__.py) to match the wanted new version.
- create a new [`tag`](https://git-scm.com/docs/git-tag) with the release name, e.g. `git tag v0.0.1 && git push origin v0.0.1` or from the GitHub UI.
- create a new release from GitHub UI

The CI will run when you create the new release.

# Docs
We use MK docs. This repo comes with the zeta docs. All the docs configurations are already here along with the readthedocs configs.
# Simba



Expand Down
14 changes: 11 additions & 3 deletions simba/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
from zeta.nn import MambaBlock


class EMM(nn.Module):
class EMMImage(nn.Module):
"""
EMM (Element-wise Multiplication Module) is a PyTorch module that performs element-wise multiplication
between two tensors.
Expand All @@ -22,8 +22,15 @@ def __init__(
super().__init__()

def forward(self, x: Tensor, weight: Tensor) -> Tensor:
return x * weight
x_b, x_h, x_w, x_c = x.shape

# Weight shape
c_b, c_d, c_d = weight.shape

# Something

# Multiply
return x * weight


class EinFFT(nn.Module):
Expand Down Expand Up @@ -111,9 +118,10 @@ def forward(self, x: Tensor) -> Tensor:
normed_new = nn.LayerNorm(d)(out)

# einfft
fasted = normed_new

# Dropout
out = self.dropout(normed_new)
out = self.dropout(fasted)

# residual
return out + residual_new

0 comments on commit 8276a95

Please sign in to comment.