hippogriff is a project

Author: proger

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Volodymyr Kyrylov
+
+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.

README.md

@@ -1,10 +1,8 @@
-# Hawk and Griffin
+# Hippogriff
 
-This repository implements [Griffin: Mixing Gated Linear Recurrences with Local Attention for Efficient Language Models](https://arxiv.org/abs/2402.19427v1)
+This repository implements Hawk and Griffin blocks from [Griffin: Mixing Gated Linear Recurrences with Local Attention for Efficient Language Models](https://arxiv.org/abs/2402.19427v1) using [Accelerated Scan](https://github.com/proger/accelerated-scan) and [Flash Attention](https://github.com/Dao-AILab/flash-attention) for PyTorch.
 
-Dependencies:
 ```
-pip install torch accelerated-scan
+pip install hippogriff
 ```
 
-Please visit my accelerated-scan project: https://github.com/proger/accelerated-scan

model.py hippogriff.pymodel.py renamed to hippogriff.py

@@ -1,3 +1,5 @@
+__version__ = '0.0.1'
+
 from dataclasses import dataclass
 import torch
 import torch.nn as nn

pyproject.toml

@@ -0,0 +1,26 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "hippogriff"
+dynamic = ["version"]
+dependencies = [
+  "torch>=2.1",
+  "accelerated-scan",
+  "flash-attn>=2.3",
+]
+authors = [
+  { name="Volodymyr Kyrylov", email="[email protected]" },
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+requires-python = ">= 3.8"
+license = {file = "LICENSE"}
+readme = "README.md"
+
+[tool.hatch.version]
+path = "hippogriff.py"