Upload FlashSTU

README.md

@@ -0,0 +1,199 @@
+---
+library_name: transformers
+tags: []
+---
+
+# Model Card for Model ID
+
+<!-- Provide a quick summary of what the model is/does. -->
+
+
+
+## Model Details
+
+### Model Description
+
+<!-- Provide a longer summary of what this model is. -->
+
+This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
+
+- **Developed by:** [More Information Needed]
+- **Funded by [optional]:** [More Information Needed]
+- **Shared by [optional]:** [More Information Needed]
+- **Model type:** [More Information Needed]
+- **Language(s) (NLP):** [More Information Needed]
+- **License:** [More Information Needed]
+- **Finetuned from model [optional]:** [More Information Needed]
+
+### Model Sources [optional]
+
+<!-- Provide the basic links for the model. -->
+
+- **Repository:** [More Information Needed]
+- **Paper [optional]:** [More Information Needed]
+- **Demo [optional]:** [More Information Needed]
+
+## Uses
+
+<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
+
+### Direct Use
+
+<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+
+[More Information Needed]
+
+### Downstream Use [optional]
+
+<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
+
+[More Information Needed]
+
+### Out-of-Scope Use
+
+<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+
+[More Information Needed]
+
+## Bias, Risks, and Limitations
+
+<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+
+[More Information Needed]
+
+### Recommendations
+
+<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+
+Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
+
+## How to Get Started with the Model
+
+Use the code below to get started with the model.
+
+[More Information Needed]
+
+## Training Details
+
+### Training Data
+
+<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
+
+[More Information Needed]
+
+### Training Procedure
+
+<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
+
+#### Preprocessing [optional]
+
+[More Information Needed]
+
+
+#### Training Hyperparameters
+
+- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
+
+#### Speeds, Sizes, Times [optional]
+
+<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
+
+[More Information Needed]
+
+## Evaluation
+
+<!-- This section describes the evaluation protocols and provides the results. -->
+
+### Testing Data, Factors & Metrics
+
+#### Testing Data
+
+<!-- This should link to a Dataset Card if possible. -->
+
+[More Information Needed]
+
+#### Factors
+
+<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
+
+[More Information Needed]
+
+#### Metrics
+
+<!-- These are the evaluation metrics being used, ideally with a description of why. -->
+
+[More Information Needed]
+
+### Results
+
+[More Information Needed]
+
+#### Summary
+
+
+
+## Model Examination [optional]
+
+<!-- Relevant interpretability work for the model goes here -->
+
+[More Information Needed]
+
+## Environmental Impact
+
+<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
+
+Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
+
+- **Hardware Type:** [More Information Needed]
+- **Hours used:** [More Information Needed]
+- **Cloud Provider:** [More Information Needed]
+- **Compute Region:** [More Information Needed]
+- **Carbon Emitted:** [More Information Needed]
+
+## Technical Specifications [optional]
+
+### Model Architecture and Objective
+
+[More Information Needed]
+
+### Compute Infrastructure
+
+[More Information Needed]
+
+#### Hardware
+
+[More Information Needed]
+
+#### Software
+
+[More Information Needed]
+
+## Citation [optional]
+
+<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
+
+**BibTeX:**
+
+[More Information Needed]
+
+**APA:**
+
+[More Information Needed]
+
+## Glossary [optional]
+
+<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
+
+[More Information Needed]
+
+## More Information [optional]
+
+[More Information Needed]
+
+## Model Card Authors [optional]
+
+[More Information Needed]
+
+## Model Card Contact
+
+[More Information Needed]

config.json

@@ -0,0 +1,27 @@
+{
+  "architectures": [
+    "FlashSTU"
+  ],
+  "auto_map": {
+    "AutoConfig": "config.FlashSTUConfig",
+    "AutoModel": "model.FlashSTU"
+  },
+  "bias": false,
+  "bsz": 8,
+  "dropout": 0.0,
+  "mlp_scale": 4,
+  "model_type": "FlashSTU",
+  "n_embd": 768,
+  "n_heads": 12,
+  "n_layers": 12,
+  "num_eigh": 16,
+  "seq_len": 4096,
+  "softcap": 50.0,
+  "torch_dtype": "float32",
+  "transformers_version": "4.44.0",
+  "use_approx": true,
+  "use_flash_fft": true,
+  "use_hankel_L": false,
+  "vocab_size": 200064,
+  "window_size": 64
+}

config.py

@@ -0,0 +1,40 @@
+from transformers import PretrainedConfig
+
+class FlashSTUConfig(PretrainedConfig):
+    model_type = "FlashSTU"
+
+    def __init__(
+        self,
+        bsz: int = 8,
+        n_embd: int = 768,
+        n_heads: int = 12,
+        n_layers: int = 12,
+        seq_len: int = 4096,
+        window_size: int = 64,
+        vocab_size: int = 200064,
+        mlp_scale: int = 4,
+        bias: bool = False,
+        dropout: float = 0.0,
+        num_eigh: int = 16,
+        use_hankel_L: bool = False,
+        use_flash_fft: bool = True,
+        use_approx: bool = True,
+        softcap: float = 50.0,
+        **kwargs,
+    ):
+        super().__init__(**kwargs)
+        self.bsz = bsz
+        self.n_embd = n_embd
+        self.n_heads = n_heads
+        self.n_layers = n_layers
+        self.seq_len = seq_len
+        self.window_size = window_size
+        self.vocab_size = vocab_size
+        self.mlp_scale = mlp_scale
+        self.bias = bias
+        self.dropout = dropout
+        self.num_eigh = num_eigh
+        self.use_hankel_L = use_hankel_L
+        self.use_flash_fft = use_flash_fft
+        self.use_approx = use_approx
+        self.softcap = softcap

model.py

@@ -0,0 +1,138 @@
+import torch
+import torch.nn as nn
+import torch.nn.functional as F
+
+from transformers import PreTrainedModel
+
+from stu import STU
+from modules import Attention
+from utils import get_spectral_filters, nearest_power_of_two
+from flash_stu.config import FlashSTUConfig
+
+try:
+    from flashfftconv import FlashFFTConv
+    flash_fft_available = True
+except ImportError as e:
+    print(f"Unable to import FlashFFTConv: {e}. Falling back to PyTorch implementation.")
+    flash_fft_available = False
+
+try:
+    from flash_attn.modules.mlp import GatedMlp as MLP
+    triton_mlp = True
+except ImportError as e:
+    print(f"Unable to import Triton-based MLP: {e}. Falling back to vanilla SwiGLU MLP instead.")
+    from modules import MLP
+    triton_mlp = False
+
+try:
+    from flash_attn.ops.triton.layer_norm import RMSNorm
+except ImportError as e:
+    print(f"Unable to import Triton-based RMSNorm: {e}. Falling back to PyTorch implementation.")
+    from torch.nn import RMSNorm
+
+try:
+    from flash_attn.losses.cross_entropy import CrossEntropyLoss
+except ImportError as e:
+    print(f"Unable to import Triton-based cross entropy loss: {e}. Falling back to PyTorch implementation.")
+    from torch.nn import CrossEntropyLoss
+
+class Block(nn.Module):
+    def __init__(self, config, phi, n, flash_fft) -> None:
+        super(Block, self).__init__()
+        # For more complex %-split arrangements, see https://arxiv.org/pdf/2406.07887
+        self.rn_1 = RMSNorm(config.n_embd)
+        self.stu = STU(config, phi, n, flash_fft)
+        self.rn_2 = RMSNorm(config.n_embd)
+        self.attn = Attention(config)
+        self.rn_3 = RMSNorm(config.n_embd)
+        self.mlp = MLP(
+            config.n_embd, 
+            config.n_embd * config.mlp_scale, 
+            activation=F.silu, # Use SwiGLU
+            bias1=config.bias,
+            bias2=config.bias,
+        ) if triton_mlp else MLP(config)
+        self.rn_4 = RMSNorm(config.n_embd)
+
+    def forward(self, x: torch.Tensor) -> torch.Tensor:
+        x = x + self.stu(self.rn_1(x))
+        x = x + self.mlp(self.rn_2(x))
+        x = x + self.attn(self.rn_3(x))
+        x = x + self.mlp(self.rn_4(x))
+        return x
+
+class FlashSTU(PreTrainedModel):
+    config_class = FlashSTUConfig
+
+    def __init__(self, config) -> None:
+        super(FlashSTU, self).__init__(config)
+        self.config = config
+        self.n_layers = config.n_layers
+        self.n_embd = config.n_embd
+        self.mlp_scale = config.mlp_scale
+        self.seq_len = config.seq_len
+        self.n = nearest_power_of_two(self.seq_len * 2 - 1, round_up=True)
+        self.vocab_size = config.vocab_size
+        self.K = config.num_eigh
+        self.use_hankel_L = config.use_hankel_L
+        self.phi = get_spectral_filters(self.seq_len, self.K, self.use_hankel_L)
+        self.use_approx = config.use_approx
+        self.flash_fft = (
+            FlashFFTConv(self.n, dtype=torch.bfloat16) 
+            if config.use_flash_fft and flash_fft_available 
+            else None
+        )
+        self.dropout = config.dropout
+        self.bias = config.bias
+        self.loss_fn = CrossEntropyLoss()
+
+        self.flash_stu = nn.ModuleDict(
+            dict(
+                tok_emb=nn.Embedding(self.vocab_size, self.n_embd),
+                dropout=nn.Dropout(self.dropout),
+                hidden=nn.ModuleList(
+                    [
+                        Block(self.config, self.phi, self.n, self.flash_fft)
+                        for _ in range(self.n_layers)
+                    ]
+                ),
+                rn_f=RMSNorm(config.n_embd)
+            )
+        )
+        self.lm_head = nn.Linear(self.n_embd, self.vocab_size, bias=self.bias)
+
+        self.std = (self.n_embd) ** -0.5
+        self.apply(self._init_weights)
+        print("Model Parameter Count: %.2fM\n" % (self._get_num_params() / 1e6,))
+
+    def forward(self, x: torch.Tensor) -> torch.tensor:
+        tok_emb = self.flash_stu.tok_emb(x)
+        x = self.flash_stu.dropout(tok_emb)
+
+        for block in self.flash_stu.hidden:
+            x = block(x)
+        x = self.flash_stu.rn_f(x)
+
+        y_hat = self.lm_head(x)
+        return y_hat
+
+    def _get_num_params(self):
+        n_params = sum(p.numel() for p in self.parameters())
+        return n_params
+
+    def _init_weights(self, module):
+        if isinstance(module, nn.Linear):
+            if hasattr(module, "SCALE_INIT"):
+                self.std *= (2 * self.n_layers) ** -0.5
+            torch.nn.init.normal_(module.weight, mean=0.0, std=self.std)
+            if module.bias is not None:
+                torch.nn.init.zeros_(module.bias)
+        elif isinstance(module, nn.Embedding):
+            torch.nn.init.normal_(module.weight, mean=0.0, std=self.std)
+        elif isinstance(module, STU):
+            if self.use_approx:
+                torch.nn.init.xavier_normal_(module.M_inputs)
+                torch.nn.init.xavier_normal_(module.M_filters)
+            else:
+                torch.nn.init.xavier_normal_(module.M_phi_plus)
+                torch.nn.init.xavier_normal_(module.M_phi_minus)

pytorch_model.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:0e4cc22a082a4d026cc4d4d0c83bff51eaa5b4d4ae3befbc9d195c944ecd07e5
+size 1711361814