multiple doc fixes

Author: dfalbel

Diff for: .gitignore

@@ -2,3 +2,5 @@
 .Rhistory
 .RData
 docs
+examples
+gtc

Diff for: DESCRIPTION

@@ -1,14 +1,18 @@
 Package: torchdatasets
-Title: Extra datasets to use with torch
+Title: Ready to Use Extra Datasets for Torch
 Version: 0.0.0.9000
 Authors@R: 
+    c(
     person(given = "Daniel",
            family = "Falbel",
            role = c("aut", "cre"),
            email = "[email protected]"
-           )
-Description: Provides datasets in a format that can be easily used by the torch
-    package.
+           ),
+    person(family = "RStudio", role = c("cph"))
+    )
+Description: Provides datasets in a format that can be easily consumed by torch 'dataloaders'.
+  Handles data downloading from multiple sources, caching and pre-processing so
+  user can focus only on the model implementation.
 License: MIT + file LICENSE
 Encoding: UTF-8
 LazyData: true
@@ -24,7 +28,5 @@ Imports:
 Suggests: 
     testthat,
     readr
-Remotes:
-    mlverse/torchvision
 URL: https://mlverse.github.io/torchdatasets, https://github.com/mlverse/torchdatasets
 BugReports: https://github.com/mlverse/torchdatasets/issues

Diff for: LICENSE

@@ -1,2 +1,2 @@
 YEAR: 2020
-COPYRIGHT HOLDER: Daniel Falbel
+COPYRIGHT HOLDER: RStudio, PBC

Diff for: R/bird-species.R

@@ -34,6 +34,8 @@ kaggle_download <- function(name, token = NULL) {
 #' @param download wether to download or not
 #' @param ... other arguments passed to [torchvision::image_folder_dataset()].
 #'
+#' @return A [torch::dataset()] ready to be used with dataloaders.
+#'
 #' @export
 bird_species_dataset <- torch::dataset(
   inherit = torchvision::image_folder_dataset,

Diff for: R/dogs-vs-cats.R

@@ -5,6 +5,8 @@
 #'
 #' @inheritParams bird_species_dataset
 #'
+#' @return A [torch::dataset()] ready to be used with dataloaders.
+#'
 #' @export
 dogs_vs_cats_dataset <- torch::dataset(
   inherit = torchvision::image_folder_dataset,