readme

Author: t-rutten

README.md

@@ -0,0 +1,51 @@
+# AxonDatasets
+
+## Usage
+
+```elixir
+{train_images, train_labels} = AxonData.MNIST.download()
+
+{images_binary, tensor_type, shape} = train_images
+
+# Transform the data as it's fetched
+transform_images = fn {binary, type, shape} ->
+  binary
+  |> Nx.from_binary(type)
+  |> Nx.reshape(shape)
+  |> Nx.divide(255)
+  |> Nx.to_batched_list(32)
+end
+
+{train_images, train_labels} =
+  AxonData.MNIST.download(transform_images: transform_images)
+
+# Transform labels as well, e.g. get one-hot encoding
+transform_labels = fn {labels_binary, type, _shape} ->
+  labels_binary
+  |> Nx.from_binary(type)
+  |> Nx.new_axis(-1)
+  |> Nx.equal(Nx.tensor(Enum.to_list(0..9)))
+  |> Nx.to_batched_list(32)
+end
+
+{images, labels} =
+  AxonData.MNIST.download(
+    transform_images: transform_images,
+    transform_labels: transform_labels
+  )
+
+```
+
+## Installation
+
+```elixir
+def deps do
+  [
+    {:axon_datasets, "~> 0.1.0-dev", github: "t-rutten/axon_datasets", branch: "main"}
+  ]
+end
+```
+
+Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
+and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
+be found at [https://hexdocs.pm/axon_data](https://hexdocs.pm/axon_data).