whisper.rn 0.4.0-rc.8 → 0.4.0

package/cpp/ggml-opt.h

@@ -0,0 +1,237 @@
+// This file contains functionality for training models using GGML.
+// It is not strictly needed vs. just vanilla GGML but it provides a more high-level interface for common needs such as datasets.
+// At the bottom of this file especially there are relatively high-level functions that are suitable use or adaptation in user code.
+//
+// Module maintainer: Johannes Gäßler (@JohannesGaessler, johannesg@5d6.de)
+
+#pragma once
+
+#include "ggml.h"
+#include "ggml-backend.h"
+
+#include <stdint.h>
+
+#ifdef  __cplusplus
+extern "C" {
+#endif
+
+    struct wsp_ggml_opt_dataset;
+    struct wsp_ggml_opt_context;
+    struct wsp_ggml_opt_result;
+
+    typedef struct wsp_ggml_opt_dataset * wsp_ggml_opt_dataset_t;
+    typedef struct wsp_ggml_opt_context * wsp_ggml_opt_context_t;
+    typedef struct wsp_ggml_opt_result  * wsp_ggml_opt_result_t;
+
+    // ====== Loss ======
+
+    // built-in loss types, i.e. the built-in quantities minimized by the optimizer
+    // custom loss types can be defined via mean or sum which simply reduce the outputs for all datapoints to a single value
+    enum wsp_ggml_opt_loss_type {
+        WSP_GGML_OPT_LOSS_TYPE_MEAN,
+        WSP_GGML_OPT_LOSS_TYPE_SUM,
+        WSP_GGML_OPT_LOSS_TYPE_CROSS_ENTROPY,
+        WSP_GGML_OPT_LOSS_TYPE_MEAN_SQUARED_ERROR,
+    };
+
+    // ====== Dataset ======
+
+    WSP_GGML_API wsp_ggml_opt_dataset_t wsp_ggml_opt_dataset_init(
+            enum wsp_ggml_type type_data,    // the type for the internal data tensor
+            enum wsp_ggml_type type_label,   // the type for the internal labels tensor
+            int64_t        ne_datapoint, // number of elements per datapoint
+            int64_t        ne_label,     // number of elements per label
+            int64_t        ndata,        // total number of datapoints/labels
+            int64_t        ndata_shard); // number of datapoints/labels per shard (unit at which the dataset is shuffled/copied)
+    WSP_GGML_API void wsp_ggml_opt_dataset_free(wsp_ggml_opt_dataset_t dataset);
+
+    // get underlying tensors that store the data
+    WSP_GGML_API int64_t              wsp_ggml_opt_dataset_ndata (wsp_ggml_opt_dataset_t dataset);
+    WSP_GGML_API struct wsp_ggml_tensor * wsp_ggml_opt_dataset_data  (wsp_ggml_opt_dataset_t dataset); // shape = [ne_datapoint, ndata]
+    WSP_GGML_API struct wsp_ggml_tensor * wsp_ggml_opt_dataset_labels(wsp_ggml_opt_dataset_t dataset); // shape = [nd_label,     ndata]
+
+    // shuffle idata first datapoints from dataset with RNG from opt_ctx, shuffle all datapoints if idata is negative
+    WSP_GGML_API void wsp_ggml_opt_dataset_shuffle(wsp_ggml_opt_context_t opt_ctx, wsp_ggml_opt_dataset_t dataset, int64_t idata);
+
+    // get batch at position ibatch from dataset and copy the data to data_batch and labels_batch
+    WSP_GGML_API void wsp_ggml_opt_dataset_get_batch(
+            wsp_ggml_opt_dataset_t   dataset,
+            struct wsp_ggml_tensor * data_batch,   // shape = [ne_datapoint, ndata_batch]
+            struct wsp_ggml_tensor * labels_batch, // shape = [ne_label,     ndata_batch]
+            int64_t              ibatch);
+    WSP_GGML_API void wsp_ggml_opt_dataset_get_batch_host(
+            wsp_ggml_opt_dataset_t   dataset,
+            void               * data_batch,
+            size_t               nb_data_batch,
+            void               * labels_batch,
+            int64_t              ibatch);
+
+    // ====== Model / Context ======
+
+    enum wsp_ggml_opt_build_type {
+        WSP_GGML_OPT_BUILD_TYPE_FORWARD = 10,
+        WSP_GGML_OPT_BUILD_TYPE_GRAD    = 20,
+        WSP_GGML_OPT_BUILD_TYPE_OPT     = 30,
+    };
+
+    // parameters that control which optimizer is used and how said optimizer tries to find the minimal loss
+    struct wsp_ggml_opt_optimizer_params {
+        // AdamW optimizer parameters
+        struct {
+            float alpha; // learning rate
+            float beta1;
+            float beta2;
+            float eps;   // epsilon for numerical stability
+            float wd;    // weight decay for AdamW, use 0.0f to disable
+        } adamw;
+    };
+
+    // callback to calculate optimizer parameters prior to a backward pass
+    // userdata can be used to pass arbitrary data
+    typedef struct wsp_ggml_opt_optimizer_params (*wsp_ggml_opt_get_optimizer_params)(void * userdata);
+
+    // returns the default optimizer params (constant, hard-coded values)
+    // userdata is not used
+    WSP_GGML_API struct wsp_ggml_opt_optimizer_params wsp_ggml_opt_get_default_optimizer_params(void * userdata);
+
+    // casts userdata to wsp_ggml_opt_optimizer_params and returns it
+    WSP_GGML_API struct wsp_ggml_opt_optimizer_params wsp_ggml_opt_get_constant_optimizer_params(void * userdata);
+
+    // parameters for initializing a new optimization context
+    struct wsp_ggml_opt_params {
+        wsp_ggml_backend_sched_t backend_sched; // defines which backends are used to construct the compute graphs
+
+        // by default the forward graph needs to be reconstructed for each eval
+        // if ctx_compute, inputs, and outputs are set the graphs are instead allocated statically
+        struct wsp_ggml_context * ctx_compute;
+        struct wsp_ggml_tensor  * inputs;
+        struct wsp_ggml_tensor  * outputs;
+
+        enum wsp_ggml_opt_loss_type  loss_type;
+        enum wsp_ggml_opt_build_type build_type;
+
+        int32_t opt_period; // after how many gradient accumulation steps an optimizer step should be done
+
+        wsp_ggml_opt_get_optimizer_params get_opt_pars; // callback for calculating optimizer parameters
+        void * get_opt_pars_ud;                     // userdata for calculating optimizer parameters
+    };
+
+    // get parameters for an optimization context with defaults set where possible
+    // parameters for which no sensible defaults exist are supplied as arguments to this function
+    WSP_GGML_API struct wsp_ggml_opt_params wsp_ggml_opt_default_params(
+            wsp_ggml_backend_sched_t    backend_sched,
+            enum wsp_ggml_opt_loss_type loss_type);
+
+    WSP_GGML_API wsp_ggml_opt_context_t wsp_ggml_opt_init(struct wsp_ggml_opt_params params);
+    WSP_GGML_API void wsp_ggml_opt_free(wsp_ggml_opt_context_t opt_ctx);
+
+    // set gradients to zero, initilize loss, and optionally reset the optimizer
+    WSP_GGML_API void wsp_ggml_opt_reset(wsp_ggml_opt_context_t opt_ctx, bool optimizer);
+
+    WSP_GGML_API bool wsp_ggml_opt_static_graphs(wsp_ggml_opt_context_t opt_ctx); // whether the graphs are allocated_statically
+
+    // get underlying tensors that store data
+    // if not using static graphs these pointers become invalid with the next call to wsp_ggml_opt_alloc
+    WSP_GGML_API struct wsp_ggml_tensor * wsp_ggml_opt_inputs(  wsp_ggml_opt_context_t opt_ctx); // forward graph input tensor
+    WSP_GGML_API struct wsp_ggml_tensor * wsp_ggml_opt_outputs( wsp_ggml_opt_context_t opt_ctx); // forward graph output tensor
+    WSP_GGML_API struct wsp_ggml_tensor * wsp_ggml_opt_labels(  wsp_ggml_opt_context_t opt_ctx); // labels to compare outputs against
+    WSP_GGML_API struct wsp_ggml_tensor * wsp_ggml_opt_loss(    wsp_ggml_opt_context_t opt_ctx); // scalar tensor that contains the loss
+    WSP_GGML_API struct wsp_ggml_tensor * wsp_ggml_opt_pred(    wsp_ggml_opt_context_t opt_ctx); // predictions made by outputs
+    WSP_GGML_API struct wsp_ggml_tensor * wsp_ggml_opt_ncorrect(wsp_ggml_opt_context_t opt_ctx); // number of matching predictions between outputs and labels
+
+    // get the gradient accumulator for a node from the forward graph
+    WSP_GGML_API struct wsp_ggml_tensor * wsp_ggml_opt_grad_acc(wsp_ggml_opt_context_t opt_ctx, struct wsp_ggml_tensor * node);
+
+    // ====== Optimization Result ======
+
+    WSP_GGML_API wsp_ggml_opt_result_t wsp_ggml_opt_result_init(void);
+    WSP_GGML_API void wsp_ggml_opt_result_free(wsp_ggml_opt_result_t result);
+    WSP_GGML_API void wsp_ggml_opt_result_reset(wsp_ggml_opt_result_t result);
+
+    // get data from result, uncertainties are optional and can be ignored by passing NULL
+    WSP_GGML_API void wsp_ggml_opt_result_ndata(   wsp_ggml_opt_result_t result, int64_t * ndata);                  // writes 1 value, number of datapoints
+    WSP_GGML_API void wsp_ggml_opt_result_loss(    wsp_ggml_opt_result_t result, double  * loss,     double * unc); // writes 1 value
+    WSP_GGML_API void wsp_ggml_opt_result_pred(    wsp_ggml_opt_result_t result, int32_t * pred);                   // writes ndata values
+    WSP_GGML_API void wsp_ggml_opt_result_accuracy(wsp_ggml_opt_result_t result, double  * accuracy, double * unc); // writes 1 value
+
+    // ====== Computation ======
+
+    // if not using static graphs, this function must be called prior to wsp_ggml_opt_alloc
+    WSP_GGML_API void wsp_ggml_opt_prepare_alloc(
+        wsp_ggml_opt_context_t    opt_ctx,
+        struct wsp_ggml_context * ctx_compute,
+        struct wsp_ggml_cgraph  * gf,
+        struct wsp_ggml_tensor  * inputs,
+        struct wsp_ggml_tensor  * outputs);
+
+    // allocate the next graph for evaluation, either forward or forward + backward
+    // must be called exactly once prior to calling wsp_ggml_opt_eval
+    WSP_GGML_API void wsp_ggml_opt_alloc(wsp_ggml_opt_context_t opt_ctx, bool backward);
+
+    // do forward pass, increment result if not NULL, do backward pass if allocated
+    WSP_GGML_API void wsp_ggml_opt_eval(wsp_ggml_opt_context_t opt_ctx, wsp_ggml_opt_result_t result);
+
+    // ############################################################################
+    // ## The high-level functions start here. They do not depend on any private ##
+    // ## functions or structs and can be copied to and adapted for user code.   ##
+    // ############################################################################
+
+    // ====== Intended Usage ======
+    //
+    // 1. Select the appropriate loss for your problem.
+    // 2. Create a dataset and set the data for the "data" tensor. Also set the "labels" tensor if your loss needs them.
+    //    Setting the shard size to 1 will be fine, it's the granularity with which data is shuffled/loaded (bigger values are faster).
+    // 3. Create a GGML graph for your model with no_alloc == true. Use two separate contexts for the tensors.
+    //    The first context should contain the model parameters and inputs and be allocated statically in user code.
+    //    The second context should contain all other tensors and will be (re)allocated automatically.
+    //    Due to this automated allocation the data of the second context is not defined when accessed in user code.
+    //    Note that the second dimension of the inputs/outputs are interpreted as the number of datapoints in those tensors.
+    // 4. Call wsp_ggml_opt_fit. If you need more control you can use wsp_ggml_opt_epoch instead.
+
+    // signature for a callback while evaluating opt_ctx on dataset, called after an evaluation
+    typedef void (*wsp_ggml_opt_epoch_callback)(
+            bool               train,       // true after training evaluation, false after validation evaluation
+            wsp_ggml_opt_context_t opt_ctx,
+            wsp_ggml_opt_dataset_t dataset,
+            wsp_ggml_opt_result_t  result,      // result associated with the dataset subsection
+            int64_t            ibatch,      // number of batches that have been evaluated so far
+            int64_t            ibatch_max,  // total number of batches in this dataset subsection
+            int64_t            t_start_us); // time at which the evaluation on the dataset subsection was started
+
+    // do training on front of dataset, do evaluation only on back of dataset
+    WSP_GGML_API void wsp_ggml_opt_epoch(
+            wsp_ggml_opt_context_t      opt_ctx,
+            wsp_ggml_opt_dataset_t      dataset,
+            wsp_ggml_opt_result_t       result_train,   // result to increment during training, ignored if NULL
+            wsp_ggml_opt_result_t       result_eval,    // result to increment during evaluation, ignored if NULL
+            int64_t                 idata_split,    // data index at which to split training and evaluation
+            wsp_ggml_opt_epoch_callback callback_train,
+            wsp_ggml_opt_epoch_callback callback_eval);
+
+    // callback that prints a progress bar on stderr
+    WSP_GGML_API void wsp_ggml_opt_epoch_callback_progress_bar(
+            bool               train,
+            wsp_ggml_opt_context_t opt_ctx,
+            wsp_ggml_opt_dataset_t dataset,
+            wsp_ggml_opt_result_t  result,
+            int64_t            ibatch,
+            int64_t            ibatch_max,
+            int64_t            t_start_us);
+
+    // fit model defined by inputs and outputs to dataset
+    WSP_GGML_API void wsp_ggml_opt_fit(
+            wsp_ggml_backend_sched_t            backend_sched,  // backend scheduler for constructing the compute graphs
+            struct wsp_ggml_context           * ctx_compute,    // context with temporarily allocated tensors to calculate the outputs
+            struct wsp_ggml_tensor            * inputs,         // input tensor with shape [ne_datapoint, ndata_batch]
+            struct wsp_ggml_tensor            * outputs,        // output tensor, must have shape [ne_label, ndata_batch] if labels are used
+            wsp_ggml_opt_dataset_t              dataset,        // dataset with data and optionally also labels
+            enum wsp_ggml_opt_loss_type         loss_type,      // loss to minimize
+            wsp_ggml_opt_get_optimizer_params   get_opt_pars,   // callback to get optimizer params, userdata is pointer to epoch (of type int64_t)
+            int64_t                         nepoch,         // how many times the dataset should be iterated over
+            int64_t                         nbatch_logical, // datapoints optimizer step, must be a multiple of ndata_batch in inputs/outputs
+            float                           val_split,      // fraction of the dataset to use for validation, must be in [0.0f, 1.0f)
+            bool                            silent);        // whether or not info prints to stderr should be suppressed
+
+#ifdef  __cplusplus
+}
+#endif