From 15af4e52e8b98a37f11abf5dcec8e5848afc6109 Mon Sep 17 00:00:00 2001
From: Szymon Tworkowski <szymonxai@users.noreply.huggingface.co>
Date: Sun, 17 Mar 2024 05:49:40 +0000
Subject: [PATCH] Update README.md

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

diff --git a/README.md b/README.md
index 154df82..9144263 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,19 @@
 ---
 license: apache-2.0
 ---
+# Grok-1
+
+This repository contains JAX example code for loading and running the Grok-1 open-weights model.
+
+Make sure to download the `int8` checkpoint to the `checkpoints` directory and run
+
+```shell
+pip install -r requirements.txt
+python transformer.py
+```
+
+to test the code.
+
+You should be seeing output from the language model.
+
+Due to the large size of the model (314B parameters), a multi-GPU machine is required to test the model with the example code.