spell check

R/dataset.R

@@ -2,7 +2,7 @@
 #'
 #' This function uses the `torchvision` package to read and transform the
 #' image in a torch tensor. The function tries to adjust the dimensions to
-#' deal with black and white or coloured images.
+#' deal with black and white or colored images.
 #'
 #' @param x character vector with the paths to image files.
 #' @param input_dim resize image to dimension. Defaults to 32x192, which is

R/fit.R

@@ -14,7 +14,7 @@
 #' @param dense_units number of dense units to use after convolution steps.
 #'   Defaults to 200.
 #' @param decay Weight decay applied each epoch.
-#' @param batch_size Minibatch size. Default 40.
+#' @param batch_size Mini batch size. Default 40.
 #' @param epochs Number of epochs to use. Default 100. The model uses early
 #'   stopping, so it is possible that the procedure ends before the total
 #'   number of epochs actually run.

R/generate.R

@@ -10,11 +10,11 @@
 #' @param n_chars captcha length. Defaults to 4.
 #' @param n_rows,n_cols image dimensions. Defaults to 60x120 image.
 #' @param p_rotate probability to add rotation. Defaults to 80%.
-#' @param p_line probability to add strikethrough line. Defaults to 80%.
+#' @param p_line probability to add strike through line. Defaults to 80%.
 #' @param p_stroke probability to add stroke color. Defaults to 30%.
 #' @param p_box probability to add bounding box to text. Defaults to 30%.
 #' @param p_implode probability to add imploding effect. Defaults to 20%.
-#' @param p_oilpaint probability to add oilpaint effect. Defaults to 0.
+#' @param p_oilpaint probability to add oil paint effect. Defaults to 0.
 #' @param p_noise probability to add random noise to image. Defaults to 40%.
 #' @param p_lat probability to add LAT algorithm to image. Defaults to 0.
 #'

R/load.R

@@ -9,7 +9,7 @@
 #' The `captcha_load_model()` function downloads a model using
 #' [piggyback::pb_download()] and returns a `luz_module_fitted` object.
 #'
-#' @param repo repo in the form `"<user>/<captcha>"`.
+#' @param repo repository in the form `"<user>/<captcha>"`.
 #'   Defaults to `"decryptr/captcha"`
 #' @param tag tag name of the release to load the file.
 #'

R/metrics.R

@@ -5,7 +5,7 @@
 #'
 #' This function is a generator created using [luz::luz_metric()] function.
 #' It has a `initialize()` method that sets the total number of instances
-#' and total number of correct predictions as zero. For any minibatch, it
+#' and total number of correct predictions as zero. For any mini batch, it
 #' has an `update()` method that updates the total number of instances and
 #' total number of correct predictions with new data. Finally, it has a
 #' `compute()` method that calculates accuracy from the total number of

R/model.R

@@ -20,7 +20,7 @@ calc_dim_img_one <- function(x, y) {
 #' @param input_dim (integer, integer): image input dimensions.
 #' @param output_ndigits number of tokens for each Captcha.
 #' @param output_vocab_size number of unique token values.
-#' @param vocab token labels
+#' @param vocab token labels.
 #' @param transform input transform function (for prediction purposes)
 #' @param dropout (float, float) AlexNet dropout values.
 #' @param dense_units Number of dense units