From db7598773806c4c0afeef1e6ce0b7119df92a5c9 Mon Sep 17 00:00:00 2001
From: xrsrke <b3f0cus@icloud.com>
Date: Fri, 27 Oct 2023 08:37:57 +0700
Subject: [PATCH] Add citation in readme

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.md b/README.md
index b9ecf2c..a2ca0b4 100644
--- a/README.md
+++ b/README.md
@@ -95,3 +95,17 @@ We did a small scale correctness test by comparing the training losses between a
 - Big thanks to 🤗 [Hugging Face](https://huggingface.co/) for sponsoring this project with 8x A100 GPUs for testing! And [Zach Schrier](https://twitter.com/zach_schrier) for monthly twitch donations
 
 - The library's APIs are inspired by [OSLO](https://github.com/EleutherAI/oslo)'s and [ColossalAI](https://github.com/hpcaitech/ColossalAI)'s APIs.
+
+**Citing `pipegoose`**
+
+```
+@software{pipegoose,
+  title = {{pipegoose: Large-scale 4D parallelism pre-training for `transformers`}},
+  author = {},
+  url = {https://github.com/xrsrke/pipegoose},
+  doi = {},
+  month = {},
+  year = {2024},
+  version = {},
+}
+```