CRAN request: more \value{} Rd tags

Author: t-kalinowski

R/LearningRateSchedule.R

@@ -77,6 +77,8 @@
 #'
 #' @param call,initialize,get_config
 #' Recommended methods to implement. See description and details sections.
+#' @returns A function that returns `LearningRateSchedule` instances, similar to the
+#'   built-in `learning_rate_schedule_*` family of functions.
 #' @tether keras.optimizers.schedules.LearningRateSchedule
 #' @inheritSection Layer Symbols in scope
 #' @inheritParams Layer

R/history.R

@@ -61,6 +61,10 @@ print.keras_training_history <- function(x, ...) {
 #'
 #' @importFrom rlang .data
 #'
+#' @returns if `method == "ggplot2"`, the ggplot object is returned. If
+#' `method == "base"`, then this function will draw to the graphics device and
+#' return `NULL`, invisibly.
+#'
 #' @export
 plot.keras_training_history <- function(x, y, metrics = NULL, method = c("auto", "ggplot2", "base"),
                                         smooth = getOption("keras.plot.history.smooth", TRUE),
@@ -171,6 +175,7 @@ plot.keras_training_history <- function(x, y, metrics = NULL, method = c("auto",
       else
         graphics::legend(legend_location, legend = metric, pch = 1)
     }
+  invisible(NULL)
   }
 }
 

R/model-persistence.R

@@ -341,13 +341,18 @@ load_model_config <- function(filepath, custom_objects = NULL)
 #'
 #' @param object A keras model.
 #'
+#' @returns This is called primarily for the side effect of exporting `object`.
+#'   The first argument, `object` is also returned, invisibly, to enable usage
+#'   with the pipe.
+#'
 #' @exportS3Method tensorflow::export_savedmodel
 #' @tether keras.Model.export
 #' @family saving and loading functions
 # @seealso
 #  + <https://www.tensorflow.org/api_docs/python/tf/keras/Model/export>
 export_savedmodel.keras.src.models.model.Model <- function(object, export_dir_base, ...) {
   object$export(export_dir_base, ...)
+  invisible(object)
 }
 
 

R/model-training.R

@@ -119,6 +119,10 @@
 #' wrapped in a `LossScaleOptimizer`, which will dynamically
 #' scale the loss to prevent underflow.
 #'
+#' @returns This is called primarily for the side effect of modifying `object`
+#'   in-place. The first argument `object` is also returned, invisibly, to
+#'   enable usage with the pipe.
+#'
 #' @param object Keras model object
 #' @param ... Additional arguments passed on to the `compile()` model method.
 #' @export

R/reexports.R

@@ -5,6 +5,10 @@
 #' @name %>%
 #' @rdname pipe
 #' @keywords internal
+#' @returns Most commonly, the result of calling the right hand side with the
+#'   left hand side as an argument: `rhs(lhs)`. See the magritter vignette for
+#'   other, more advanced, usages.
+#' @export
 #' @export
 #' @importFrom magrittr %<>% %>%
 #' @usage lhs \%>\% rhs
@@ -21,6 +25,8 @@ magrittr::`%<>%`
 #' @name %<-%
 #' @rdname multi-assign
 #' @keywords internal
+#' @returns The right-hand-side argument, `value`, invisibly. This called
+#'   primarily for it's side-effect of assigning symbols in the current frame.
 #' @export
 #' @importFrom zeallot %<-%
 #' @usage x \%<-\% value