Updating documentation

Author: davidrsch

R/compile_keras_grid.R

@@ -40,8 +40,8 @@
 #'   }
 #'
 #' @examples
-#' \dontrun{
-#' if (keras::is_keras_available()) {
+#' \donttest{
+#' if (requireNamespace("keras3", quietly = TRUE)) {
 #'
 #' # 1. Define a kerasnip model specification
 #' create_keras_sequential_spec(
@@ -193,7 +193,7 @@ compile_keras_grid <- function(spec, grid, x, y) {
 #'   are removed, leaving a clean grid ready for tuning.
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' # Continuing the example from `compile_keras_grid`:
 #'
 #' # `compiled_grid` contains one row with an error.
@@ -241,7 +241,7 @@ extract_valid_grid <- function(compiled_grid) {
 #'   effect of printing a summary to the console.
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' # Continuing the example from `compile_keras_grid`:
 #'
 #' # `compiled_grid` contains one row with an error.

R/create_keras_functional_spec.R

@@ -72,7 +72,7 @@
 #'
 #' @export
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' if (requireNamespace("keras3", quietly = TRUE)) {
 #'   library(keras3)
 #'   library(parsnip)

R/create_keras_sequential_spec.R

@@ -61,7 +61,7 @@
 #'
 #' @export
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' if (requireNamespace("keras3", quietly = TRUE)) {
 #' library(keras3)
 #' library(parsnip)

R/create_keras_spec_helpers.R

@@ -140,7 +140,7 @@ collect_spec_args <- function(
 #'
 #' @export
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' # --- Example Blocks ---
 #' # A standard dense block with one input tensor and one hyperparameter.
 #' dense_block <- function(tensor, units = 16) {

R/generic_functional_fit.R

@@ -56,7 +56,7 @@
 #' # This function is not called directly by users.
 #' # It is called internally by `parsnip::fit()`.
 #' # For example:
-#' \dontrun{
+#' \donttest{
 #' # create_keras_functional_spec(...) defines my_functional_model
 #'
 #' spec <- my_functional_model(hidden_units = 128, fit_epochs = 10) |>

R/generic_sequential_fit.R

@@ -56,7 +56,7 @@
 #' # This function is not called directly by users.
 #' # It is called internally by `parsnip::fit()`.
 #' # For example:
-#' \dontrun{
+#' \donttest{
 #' # create_keras_sequential_spec(...) defines my_sequential_model
 #'
 #' spec <- my_sequential_model(hidden_1_units = 128, fit_epochs = 10) |>

R/keras_tools.R

@@ -18,8 +18,8 @@
 #'   with.
 #'
 #' @examples
-#' \dontrun{
-#' if (keras::is_keras_available()) {
+#' \donttest{
+#' if (requireNamespace("keras3", quietly = TRUE)) {
 #'
 #' # 1. Define and fit a model ----
 #' create_keras_sequential_spec(
@@ -135,4 +135,4 @@ extract_keras_model <- function(object) {
 #' @export
 extract_keras_history <- function(object) {
   object$fit$history
-}
+}

R/remove_keras_spec.R

@@ -28,7 +28,7 @@
 #' @seealso [create_keras_sequential_spec()], [create_keras_functional_spec()]
 #' @export
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' if (requireNamespace("keras3", quietly = TRUE)) {
 #'   # First, create a dummy spec
 #'   input_block <- function(model, input_shape) {

R/utils.R

@@ -29,6 +29,7 @@
 #'   optimizer object.
 #' @seealso [register_keras_loss()], [register_keras_metric()]
 #' @export
+#' @return No return value, called for side effects.
 #' @examples
 #' if (requireNamespace("keras3", quietly = TRUE)) {
 #'   # Register a custom version of Adam with a different default beta_1
@@ -58,6 +59,7 @@ register_keras_optimizer <- function(name, optimizer_fn) {
 #' @param loss_fn The loss function.
 #' @seealso [register_keras_optimizer()], [register_keras_metric()]
 #' @export
+#' @return No return value, called for side effects.
 register_keras_loss <- function(name, loss_fn) {
   .kerasnip_custom_objects$losses[[name]] <- loss_fn
   invisible()
@@ -78,6 +80,7 @@ register_keras_loss <- function(name, loss_fn) {
 #' @param metric_fn The metric function.
 #' @seealso [register_keras_optimizer()], [register_keras_loss()]
 #' @export
+#' @return No return value, called for side effects.
 register_keras_metric <- function(name, metric_fn) {
   .kerasnip_custom_objects$metrics[[name]] <- metric_fn
   invisible()
@@ -144,6 +147,7 @@ get_keras_object <- function(
 #'   known optimizers (keras defaults + custom registered).
 #' @keywords internal
 #' @export
+#' @return A `dials` parameter object for Keras optimizers.
 optimizer_function <- function(values = NULL) {
   if (is.null(values)) {
     values <- unique(c(
@@ -164,6 +168,7 @@ optimizer_function <- function(values = NULL) {
 #'   known losses (keras defaults + custom registered).
 #' @keywords internal
 #' @export
+#' @return A `dials` parameter object for Keras loss.
 loss_function_keras <- function(values = NULL) {
   if (is.null(values)) {
     values <- unique(c(keras_losses, names(.kerasnip_custom_objects$losses)))
@@ -402,8 +407,8 @@ process_y_sequential <- function(
 #'
 #' @return The `parsnip` model environment.
 #' @examples
-#' \dontrun{
-#' model_env <- kerasnip:::get_model_env()
+#' \donttest{
+#' model_env <- kerasnip::get_model_env()
 #' }
 #' @keywords internal
 #' @export