Reproducible and automatically configure development environments

.env.public

@@ -0,0 +1 @@
+GROK_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

.envrc

@@ -0,0 +1,4 @@
+dotenv .env.public
+dotenv_if_exists
+use flake
+layout python

.github/hooks/pre-commit

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+ruff check ./

.github/workflows/test.yml

@@ -0,0 +1,8 @@
+name: test
+on: [push, pull_request]
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: chartboost/ruff-action@v1

.gitignore

@@ -1,2 +1,5 @@
+/.direnv/
+/.venv/
 checkpoints/*
 !checkpoints/README.md
+__pycache__/

Justfile

@@ -0,0 +1,14 @@
+[private]
+@default:
+	just --list --unsorted
+
+# Run the sample prompt against the model
+test:
+	python run.py
+
+# Download the weights for the Grok model
+download-weights:
+	transmission-cli \
+		--download-dir ./checkpoints \
+		$GROK_MAGNET_LINK
+	ln -s ./checkpoints/grok-1/ckpt-0 ./checkpoints/ckpt-0

README.md

@@ -49,6 +49,18 @@ pip install huggingface_hub[hf_transfer]
 huggingface-cli download xai-org/grok-1 --repo-type model --include ckpt-0/* --local-dir checkpoints --local-dir-use-symlinks False
 ```
 
+# Reproducible Environment
+
+Those familiar with `nix` and `direnv` can use a reproducible development environment.
+
+```sh
+cd ~/src/grok-1
+direnv allow .
+just --list
+just download-weights
+just test
+```
+
 # License
 
 The code and associated Grok-1 weights in this release are licensed under the

flake.nix

@@ -0,0 +1,48 @@
+{
+  inputs = {
+    nixpkgs.url = "github:nixos/nixpkgs/nixos-23.11";
+    flake-utils.url = "github:numtide/flake-utils";
+  };
+
+  outputs = { self, nixpkgs, flake-utils }: flake-utils.lib.eachDefaultSystem (system:
+    let
+      pkgs = import nixpkgs { inherit system; };
+      python = pkgs.python311;
+    in
+    {
+      devShells.default = pkgs.mkShell {
+
+        # build-time
+        nativeBuildInputs = with pkgs; [
+          bashInteractive
+        ];
+
+        # run-time
+        buildInputs = (with pkgs; [
+          transmission
+          just
+        ]) ++ (with python.pkgs; [
+          setuptools
+          wheel
+          venvShellHook
+          pkgs.ruff
+        ]);
+
+        # python setup
+        src = null;
+        venvDir = ".venv";
+        postVenv = ''
+          unset SOURCE_DATE_EPOCH
+        '';
+        postShellHook = ''
+          unset SOURCE_DATE_EPOCH
+          unset LD_PRELOAD
+          PYTHONPATH=$PWD/$venvDir/${python.sitePackages}:$PYTHONPATH
+          pip install --require-virtualenv -r requirements.txt | grep -v 'already satisfied'
+          git config --local core.hooksPath .github/hooks
+        '';
+
+      };
+    }
+  );
+}