Add assets and update README.md

Author: Kaweees

.editorconfig

@@ -17,6 +17,10 @@ insert_final_newline = true
 indent_style = space
 indent_size = 3
 
+[*.nix]
+indent_style = space
+indent_size = 2
+
 [*.zig]
 indent_style = space
 indent_size = 4

.gitignore

@@ -2,6 +2,7 @@
 
 !.github/
 !assets/
+!assets/**/
 !.editorconfig
 !.gitattributes
 !.gitignore
@@ -14,8 +15,10 @@
 !src/**/
 !examples/
 
-!*.lock
 !*.md
+!*.svg
+!*.png
 !*.nix
+!*.lock
 !*.zig
 !*.zon

README.md

@@ -23,8 +23,7 @@
 </div>
 
 <!-- ABOUT THE PROJECT -->
-
-A Zig implementation of Karpathy's micrograd.
+A scalar-valued automatic differentiation (autograd) engine for deep learning written in Zig.
 
 ### Built With
 
@@ -36,9 +35,9 @@ A Zig implementation of Karpathy's micrograd.
 ## Preview
 
 <p align="center">
-  <img src="assets/img/demo.mp4"
+  <img src="assets/img/train.png"
   width = "80%"
-  alt = "Video demonstration"
+  alt = "Training a model on MNIST dataset"
   />
 </p>
 
@@ -76,7 +75,7 @@ To get a local copy of the project up and running on your machine, follow these
 4. Run the project
 
    ```sh
-   just run <package_name>
+   just run
    ```
 
 ### Add as a dependency
@@ -138,6 +137,9 @@ kiwigrad/
 ├── src/                           # Library source files
 │   ├── lib.zig                      # Public API entry point
 │   └── ...
+├── examples/                      # Example projects
+│   ├── benchmark.zig                # Benchmarking the library
+│   └── train.zig                    # Training a model on MNIST
 ├── build.zig                      # Zig build script
 ├── build.zig.zon                  # Zig build script dependencies
 ├── LICENSE                        # Project license

assets/img/train.png

@@ -71,6 +71,6 @@ pub fn main() !void {
     print("output.data: {d:.4}\n", .{output.data});
     print("output.grad: {d:.4}\n", .{output.grad});
 
-    try draw_graph(f64, output, "n_f64", stdout);
+    try draw_graph(f64, output, "assets/img/train", stdout);
     try bw.flush(); // Don't forget to flush!
 }

examples/train.zig

@@ -4,7 +4,7 @@ pkgs.mkShell {
   buildInputs = with pkgs; [
     zig # Zig compiler
     just # Just runner
-    nixfmt # Nix formatter
+    nixfmt-classic # Nix formatter
     graphviz # Graphviz
   ];
 

shell.nix

@@ -1,6 +1,4 @@
-//! By convention, root.zig is the root source file when making a library. If
-//! you are making an executable, the convention is to delete this file and
-//! start with main.zig instead.
+//! A scalar-valued automatic differentiation (autograd) engine for deep learning written in Zig.
 
 const std = @import("std");
 const testing = std.testing;