knightnemo commited on
Commit
479f73c
·
verified ·
1 Parent(s): 2180f62

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +46 -8
README.md CHANGED
@@ -7,13 +7,51 @@ sdk: static
7
  pinned: false
8
  ---
9
 
10
- **OpenWAM is a Modular Open-Source Framework for Systematic WAM Training, Inference and Deployment.**
11
 
12
- This framework includes three parts:
13
- 1. **OpenWAM-Infra**: A Modular Infrastructure for World-Action Modeling.
14
- 2. **OpenWAM-Study**: Design Principles for World–Action Models.
15
- 3. **OpenWAM-Alpha**: From Principles to a Pretrained Model.
16
 
17
- In this organization, we release pretrained and finetuned checkpoints for OpenWAM. Currently, this huggingface organization includes two collections:
18
- 1. `OpenWAM-Study`: Release of Checkpoints used in systematic studying design principles of WAMs.
19
- 2. `OpenWAM-Alpha`: Release of Pretrained Checkpoints (OpenWAM-Alpha) and finetuned checkpoints on a variety of benchmarks.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
7
  pinned: false
8
  ---
9
 
10
+ <div align="center">
11
 
12
+ <img src="https://cdn-avatars.huggingface.co/v1/production/uploads/66b06fe4ce2224a4d066cc0a/MC1miu9IBqK10GW6htytf.png" width="110" alt="OpenWAM"/>
 
 
 
13
 
14
+ <h1>A Modular Open-Source Framework for Systematic Training, Inference, and Deployment of World-Action Models</h1>
15
+
16
+ [![Paper](https://img.shields.io/badge/arXiv-XXXX.XXXXX-b31b1b?style=flat-square&logo=arxiv&logoColor=white)](https://arxiv.org/abs/XXXX.XXXXX)
17
+ [![Code](https://img.shields.io/badge/GitHub-OpenWAM-181717?style=flat-square&logo=github&logoColor=white)](https://github.com/knightnemo/OpenWAM)
18
+ [![Project Page](https://img.shields.io/badge/Project-Page-1f6feb?style=flat-square&logo=googlechrome&logoColor=white)](https://YOUR-PROJECT-PAGE)
19
+ [![License](https://img.shields.io/badge/License-Apache%202.0-4c1?style=flat-square)](https://www.apache.org/licenses/LICENSE-2.0)
20
+
21
+ </div>
22
+
23
+ ---
24
+ ## 🧭 Overview
25
+
26
+ OpenWAM is an modular, open-source framework for **World-Action Modeling**. From infrastructure, through controlled empirical study, to a pretrained model, we provide an empirical recipe for building highly-performant WAMs. This project is organized into three parts:
27
+
28
+ | 🧱 | **OpenWAM-Infra** | **A Modular Infrastructure for World Action Modeling.** |
29
+ |:--:|:------:|:----:|
30
+ | 🔬 | **OpenWAM-Study** | **A Systematic Study of the Design Principles of WAMs.** |
31
+ | 🚀 | **OpenWAM-Alpha** | **From Principles to Models: An Empirical Recipe for Pretraining WAMs.** |
32
+
33
+ ---
34
+
35
+ ## 📦 Huggingface Collections
36
+
37
+ - 🔬 [`OpenWAM-Study`](https://huggingface.co/collections/OpenWAM/openwam-study) Public Release of checkpoints from our controlled study on WAM design principles.
38
+
39
+ - 🚀 [`OpenWAM-Alpha`](https://huggingface.co/collections/YOUR-ORG/openwam-alpha) Public Release of our pretrained checkpoint (**OpenWAM-Alpha**), plus finetuned variants across a range of downstream benchmarks.
40
+
41
+ ---
42
+
43
+ ## 📄 Citation
44
+
45
+ If you find OpenWAM useful in your research, please consider citing:
46
+
47
+ ```bibtex
48
+ TBD
49
+ ```
50
+
51
+ ---
52
+
53
+ <div align="center">
54
+
55
+ **Questions or feedback?** Open an issue on [GitHub](https://github.com/knightnemo/OpenWAM) or start a discussion on any model repo.
56
+
57
+ </div>