AMajor/grok-1
1
0
Fork 0
mirror of https://github.com/xai-org/grok-1.git synced 2024-09-18 03:53:00 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update readme with new instructions

Browse Source
This commit is contained in:
BIEMAX 2024-03-18 21:29:52 -03:00
parent e50578b5f5
commit 073f74eaf6
1 changed files with 30 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@ -2,28 +2,42 @@
This repository contains JAX example code for loading and running the Grok-1 open-weights model.
Make sure to download the checkpoint and place `ckpt-0` directory in `checkpoint`.
Then, run
Make sure to download the checkpoint and place `ckpt-0` directory in `checkpoints` before run the project.
```shell
pip install -r requirements.txt
python run.py
```
## 1. Downloading the weights
to test the code.
The script loads the checkpoint and samples from the model on a test input.
Due to the large size of the model (314B parameters), a machine with enough GPU memory is required to test the model with the example code.
The implementation of the MoE layer in this repository is not efficient. The implementation was chosen to avoid the need for custom kernels to validate the correctness of the model.
# Downloading the weights
You can download the weights using a torrent client and this magnet link:
You can download the weights using a torrent client in the following magnet link:
```
magnet:?xt=urn:btih:5f96d43576e3d386c9ba65b883210a393b68210e&tr=https%3A%2F%2Facademictorrents.com%2Fannounce.php&tr=udp%3A%2F%2Ftracker.coppersurfer.tk%3A6969&tr=udp%3A%2F%2Ftracker.opentrackr.org%3A1337%2Fannounce
```
## 2. Installation
1. Install the project dependencies
```bash
pip install -r requirements.txt
```
2. Run the project
```bash
python run.py
```
The script loads the checkpoint and samples from the model on a test input.
Due to the large size of the model (314B/Billion parameters), a machine with enough GPU memory is required to test the model with the example code.
The implementation of the MoE layer in this repository is not efficient. The implementation was chosen to avoid the need for custom kernels to validate the correctness of the model.
## 3. Requirements
Make sure to attend the following requirements before run the project:
- Needs either either a TPU or GPU (NVIDIA/AMD supported only)
- They have to be 8 devices (in the context of TPUs (Tensor Processing Units) or GPUs (Graphics Processing Units), they are typically talking about having access to a total of 8 individual processing units)
# License
The code and associated Grok-1 weights in this release are licensed under the