Add or update crate README files

These are short introductions to what each crate is for, mainly for use when perusing the repository on GitHub.
robertknight · Dec 23, 2024 · b88893c · b88893c
1 parent 9452fcb
commit b88893c
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 2 deletions.
diff --git a/rten-bench/README.md b/rten-bench/README.md
@@ -0,0 +1 @@
+Internal benchmarking utilities used in RTen development.
diff --git a/rten-generate/README.md b/rten-generate/README.md
@@ -0,0 +1,4 @@
+rten-generate is a layer on top of RTen which handles the generation loop for
+auto-regressive transformer models (aka. "transformer decoders" or "generative
+AI"). This includes managing the KV cache, sampling and post-processing logits
+etc.
diff --git a/rten-imageio/README.md b/rten-imageio/README.md
@@ -1,4 +1,4 @@
 # rten-imageio
 
-Library for loading images and converting them to [NdTensor]s that can be
-used as inputs for RTen models.
+Crate for loading images and converting them to tensors that can be used as
+inputs for RTen models.
diff --git a/rten-simd/src/README.md b/rten-simd/src/README.md
@@ -0,0 +1,2 @@
+This crate contains RTen's portable SIMD library. It is used to implement
+vectorized kernels for neural network operators.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Internal benchmarking utilities used in RTen development.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		This crate contains RTen's portable SIMD library. It is used to implement
		vectorized kernels for neural network operators.