Fix MNIST & FashionMNIST docs (#23)

* remove mentions of `download/1` * bump version, alphabetize datasets in readme
elixir-nx · Dec 7, 2021 · 86037e9 · 86037e9
1 parent f1fd2c8
commit 86037e9
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -8,9 +8,9 @@ Scidata currently supports the following training and test datasets:
 - CIFAR100
 - FashionMNIST
 - IMDb Reviews
-- Yelp Reviews (Full and Polarity)
+- Kuzushiji-MNIST (KMNIST)
 - MNIST
-- Kuzushiji-MNIST(KMNIST)
+- Yelp Reviews (Full and Polarity)
 
 Download or fetch datasets locally:
 
@@ -53,7 +53,7 @@ batchd_labels =
 ```elixir
 def deps do
   [
-    {:scidata, "~> 0.1.1"}
+    {:scidata, "~> 0.1.3"}
   ]
 end
 ```

diff --git a/lib/scidata/fashionmnist.ex b/lib/scidata/fashionmnist.ex
@@ -46,8 +46,6 @@ defmodule Scidata.FashionMNIST do
 
   @doc """
   Downloads the FashionMNIST test dataset or fetches it locally.
-
-  Accepts the same options as `download/1`.
   """
   def download_test() do
     {download_images(@test_image_file), download_labels(@test_label_file)}

diff --git a/lib/scidata/mnist.ex b/lib/scidata/mnist.ex
@@ -33,8 +33,6 @@ defmodule Scidata.MNIST do
 
   @doc """
   Downloads the MNIST test dataset or fetches it locally.
-
-  Accepts the same options as `download/1`.
   """
   def download_test() do
     {download_images(@test_image_file), download_labels(@test_label_file)}

diff --git a/mix.exs b/mix.exs
@@ -1,7 +1,7 @@
 defmodule Scidata.MixProject do
   use Mix.Project
 
-  @version "0.1.2"
+  @version "0.1.3"
   @repo_url "https://github.com/elixir-nx/scidata"
 
   def project do