// ====== Dataset ======
GGML_API ggml_opt_dataset_t ggml_opt_dataset_init(
- 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)
+ enum ggml_type type_data, // the type for the internal data tensor
+ enum 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)
GGML_API void ggml_opt_dataset_free(ggml_opt_dataset_t dataset);
// get underlying tensors that store the data
+ GGML_API int64_t ggml_opt_dataset_ndata (ggml_opt_dataset_t dataset);
GGML_API struct ggml_tensor * ggml_opt_dataset_data (ggml_opt_dataset_t dataset); // shape = [ne_datapoint, ndata]
GGML_API struct ggml_tensor * ggml_opt_dataset_labels(ggml_opt_dataset_t dataset); // shape = [nd_label, ndata]
struct ggml_tensor * data_batch, // shape = [ne_datapoint, ndata_batch]
struct ggml_tensor * labels_batch, // shape = [ne_label, ndata_batch]
int64_t ibatch);
+ GGML_API void ggml_opt_dataset_get_batch_host(
+ ggml_opt_dataset_t dataset,
+ void * data_batch,
+ size_t nb_data_batch,
+ void * labels_batch,
+ int64_t ibatch);
// ====== Model / Context ======
enum ggml_opt_build_type {
- GGML_OPT_BUILD_TYPE_FORWARD,
- GGML_OPT_BUILD_TYPE_GRAD,
- GGML_OPT_BUILD_TYPE_OPT,
+ GGML_OPT_BUILD_TYPE_FORWARD = 10,
+ GGML_OPT_BUILD_TYPE_GRAD = 20,
+ GGML_OPT_BUILD_TYPE_OPT = 30,
};
// parameters that control which optimizer is used and how said optimizer tries to find the minimal loss
// userdata can be used to pass arbitrary data
typedef struct ggml_opt_optimizer_params (*ggml_opt_get_optimizer_params)(void * userdata);
- // returns the default optimizer params (constant)
+ // returns the default optimizer params (constant, hard-coded values)
// userdata is not used
GGML_API struct ggml_opt_optimizer_params ggml_opt_get_default_optimizer_params(void * userdata);
+ // casts userdata to ggml_opt_optimizer_params and returns it
+ GGML_API struct ggml_opt_optimizer_params ggml_opt_get_constant_optimizer_params(void * userdata);
+
// parameters for initializing a new optimization context
struct ggml_opt_params {
ggml_backend_sched_t backend_sched; // defines which backends are used to construct the compute graphs
- struct ggml_context * ctx_compute; // created in user code, holds non-static tensors
-
- // the forward graph is defined by inputs and outputs
- // those tensors and all tensors inbetween are not intended to be reusable between multiple optimization contexts
- struct ggml_tensor * inputs;
- struct ggml_tensor * outputs;
+ // 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 ggml_context * ctx_compute;
+ struct ggml_tensor * inputs;
+ struct ggml_tensor * outputs;
enum ggml_opt_loss_type loss_type;
enum ggml_opt_build_type build_type;
// 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
- GGML_API ggml_opt_params ggml_opt_default_params(
- ggml_backend_sched_t backend_sched,
- struct ggml_context * ctx_compute,
- struct ggml_tensor * inputs,
- struct ggml_tensor * outputs,
- enum ggml_opt_loss_type loss_type);
+ GGML_API struct ggml_opt_params ggml_opt_default_params(
+ ggml_backend_sched_t backend_sched,
+ enum ggml_opt_loss_type loss_type);
GGML_API ggml_opt_context_t ggml_opt_init(struct ggml_opt_params params);
GGML_API void ggml_opt_free(ggml_opt_context_t opt_ctx);
GGML_API void ggml_opt_reset(ggml_opt_context_t opt_ctx, bool optimizer);
// get underlying tensors that store data
+ // if not using static graphs these pointers become invalid with the next call to ggml_opt_alloc
GGML_API struct ggml_tensor * ggml_opt_inputs( ggml_opt_context_t opt_ctx); // forward graph input tensor
GGML_API struct ggml_tensor * ggml_opt_outputs( ggml_opt_context_t opt_ctx); // forward graph output tensor
GGML_API struct ggml_tensor * ggml_opt_labels( ggml_opt_context_t opt_ctx); // labels to compare outputs against
GGML_API struct ggml_tensor * ggml_opt_pred( ggml_opt_context_t opt_ctx); // predictions made by outputs
GGML_API struct ggml_tensor * ggml_opt_ncorrect(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
GGML_API struct ggml_tensor * ggml_opt_grad_acc(ggml_opt_context_t opt_ctx, struct ggml_tensor * node);
// ====== Optimization Result ======
- GGML_API ggml_opt_result_t ggml_opt_result_init();
+ GGML_API ggml_opt_result_t ggml_opt_result_init(void);
GGML_API void ggml_opt_result_free(ggml_opt_result_t result);
GGML_API void ggml_opt_result_reset(ggml_opt_result_t result);
// ====== Computation ======
- // do forward pass, increment result if not NULL
- GGML_API void ggml_opt_forward(ggml_opt_context_t opt_ctx, ggml_opt_result_t result);
+ // if not using static graphs, this function must be called prior to ggml_opt_alloc
+ GGML_API void ggml_opt_prepare_alloc(
+ ggml_opt_context_t opt_ctx,
+ struct ggml_context * ctx_compute,
+ struct ggml_cgraph * gf,
+ struct ggml_tensor * inputs,
+ struct ggml_tensor * outputs);
+
+ // allocate the next graph for evaluation, either forward or forward + backward
+ // must be called exactly once prior to calling ggml_opt_eval
+ GGML_API void ggml_opt_alloc(ggml_opt_context_t opt_ctx, bool backward);
- // do forward pass, increment result if not NULL, do backward pass
- GGML_API void ggml_opt_forward_backward(ggml_opt_context_t opt_ctx, ggml_opt_result_t result);
+ // do forward pass, increment result if not NULL, do backward pass if allocated
+ GGML_API void ggml_opt_eval(ggml_opt_context_t opt_ctx, ggml_opt_result_t result);
// ############################################################################
// ## The high-level functions start here. They do not depend on any private ##
// fit model defined by inputs and outputs to dataset
GGML_API void ggml_opt_fit(
ggml_backend_sched_t backend_sched, // backend scheduler for constructing the compute graphs
- ggml_context * ctx_compute, // context with temporarily allocated tensors to calculate the outputs
- ggml_tensor * inputs, // input tensor with shape [ne_datapoint, ndata_batch]
- ggml_tensor * outputs, // output tensor, must have shape [ne_label, ndata_batch] if labels are used
+ struct ggml_context * ctx_compute, // context with temporarily allocated tensors to calculate the outputs
+ struct ggml_tensor * inputs, // input tensor with shape [ne_datapoint, ndata_batch]
+ struct ggml_tensor * outputs, // output tensor, must have shape [ne_label, ndata_batch] if labels are used
ggml_opt_dataset_t dataset, // dataset with data and optionally also labels
enum ggml_opt_loss_type loss_type, // loss to minimize
ggml_opt_get_optimizer_params get_opt_pars, // callback to get optimizer params, userdata is pointer to epoch (of type int64_t)
};
struct ggml_opt_context {
- ggml_backend_sched_t backend_sched = nullptr;
- ggml_cgraph * allocated_graph = nullptr;
- ggml_cgraph * allocated_graph_copy = nullptr;
- struct ggml_context * ctx_static = nullptr;
- struct ggml_context * ctx_static_cpu = nullptr;
- struct ggml_context * ctx_compute = nullptr;
- struct ggml_context * ctx_copy = nullptr;
- ggml_backend_buffer_t buf_static = nullptr;
- ggml_backend_buffer_t buf_static_cpu = nullptr;
- std::mt19937 rng;
+ ggml_backend_sched_t backend_sched = nullptr;
+ ggml_cgraph * allocated_graph = nullptr;
+ ggml_cgraph * allocated_graph_copy = nullptr;
+ struct ggml_context * ctx_static = nullptr;
+ struct ggml_context * ctx_cpu = nullptr;
+ struct ggml_context * ctx_compute = nullptr;
+ struct ggml_context * ctx_copy = nullptr;
+ ggml_backend_buffer_t buf_static = nullptr;
+ ggml_backend_buffer_t buf_cpu = nullptr;
+ std::mt19937 rng;
+ enum ggml_opt_loss_type loss_type;
+ enum ggml_opt_build_type build_type;
+ enum ggml_opt_build_type build_type_alloc;
struct ggml_tensor * inputs = nullptr;
struct ggml_tensor * outputs = nullptr;
struct ggml_cgraph * gf = nullptr;
struct ggml_cgraph * gb_grad = nullptr;
struct ggml_cgraph * gb_opt = nullptr;
+ bool static_graphs = false;
+ bool eval_ready = false;
+ std::vector<struct ggml_tensor *> grad_accs;
+ std::vector<struct ggml_tensor *> grad_m;
+ std::vector<struct ggml_tensor *> grad_v;
int64_t iter = 1;
int32_t opt_period = 1;
// ====== Dataset ======
-ggml_opt_dataset_t ggml_opt_dataset_init(int64_t ne_datapoint, int64_t ne_label, int64_t ndata, int64_t ndata_shard) {
+ggml_opt_dataset_t ggml_opt_dataset_init(
+ enum ggml_type type_data,
+ enum ggml_type type_label,
+ int64_t ne_datapoint,
+ int64_t ne_label,
+ int64_t ndata,
+ int64_t ndata_shard) {
GGML_ASSERT(ne_datapoint > 0);
GGML_ASSERT(ne_label >= 0);
GGML_ASSERT(ndata > 0);
result->ctx = ggml_init(params);
}
- result->data = ggml_new_tensor_2d(result->ctx, GGML_TYPE_F32, ne_datapoint, ndata);
+ result->data = ggml_new_tensor_2d(result->ctx, type_data, ne_datapoint, ndata);
result->nbs_data = ggml_nbytes(result->data) * ndata_shard/ndata;
if (ne_label > 0) {
- result->labels = ggml_new_tensor_2d(result->ctx, GGML_TYPE_F32, ne_label, ndata);
+ result->labels = ggml_new_tensor_2d(result->ctx, type_label, ne_label, ndata);
result->nbs_labels = ggml_nbytes(result->labels) * ndata_shard/ndata;
} else {
result->labels = nullptr;
delete dataset;
}
+int64_t ggml_opt_dataset_ndata(ggml_opt_dataset_t dataset) {
+ return dataset->ndata;
+}
+
struct ggml_tensor * ggml_opt_dataset_data(ggml_opt_dataset_t dataset) {
return dataset->data;
}
GGML_ASSERT( data_batch && ggml_is_contiguous(data_batch));
GGML_ASSERT(!labels_batch || ggml_is_contiguous(labels_batch));
GGML_ASSERT((labels_batch == nullptr) == (dataset->labels == nullptr));
+ GGML_ASSERT( data_batch->type == dataset->data->type);
+ GGML_ASSERT(!labels_batch || labels_batch->type == dataset->labels->type);
const size_t nb_data_batch = ggml_nbytes(data_batch);
GGML_ASSERT(nb_data_batch % dataset->nbs_data == 0);
}
}
+void ggml_opt_dataset_get_batch_host(ggml_opt_dataset_t dataset, void * data_batch, size_t nb_data_batch, void * labels_batch, int64_t ibatch) {
+ GGML_ASSERT((labels_batch == nullptr) == (dataset->labels == nullptr));
+ GGML_ASSERT(nb_data_batch % dataset->nbs_data == 0);
+
+ const int64_t shards_per_batch = nb_data_batch / dataset->nbs_data;
+
+ GGML_ASSERT((ibatch + 1)*shards_per_batch <= int64_t(dataset->permutation.size()));
+
+ for (int64_t ishard_batch = 0; ishard_batch < shards_per_batch; ++ishard_batch) {
+ const int64_t ishard = dataset->permutation[ibatch*shards_per_batch + ishard_batch];
+
+ const char * ptr_data = (const char *) dataset->data->data + ishard *dataset->nbs_data;
+ char * ptr_data_batch = (char *) data_batch + ishard_batch*dataset->nbs_data;
+ memcpy(ptr_data_batch, ptr_data, dataset->nbs_data);
+
+ if (!labels_batch) {
+ continue;
+ }
+
+ const char * ptr_labels = (const char *) dataset->labels->data + ishard *dataset->nbs_labels;
+ char * ptr_labels_batch = (char *) labels_batch + ishard_batch*dataset->nbs_labels;
+ memcpy(ptr_labels_batch, ptr_labels, dataset->nbs_labels);
+ }
+}
+
// ====== Model / Context ======
struct ggml_opt_optimizer_params ggml_opt_get_default_optimizer_params(void * userdata) {
return result;
}
+struct ggml_opt_optimizer_params ggml_opt_get_constant_optimizer_params(void * userdata) {
+ return *((struct ggml_opt_optimizer_params *) userdata);
+}
+
struct ggml_opt_params ggml_opt_default_params(
ggml_backend_sched_t backend_sched,
- struct ggml_context * ctx_compute,
- struct ggml_tensor * inputs,
- struct ggml_tensor * outputs,
enum ggml_opt_loss_type loss_type) {
return {
/*backend_sched =*/ backend_sched,
- /*ctx_compute =*/ ctx_compute,
- /*inputs =*/ inputs,
- /*logits =*/ outputs,
+ /*ctx_compute =*/ nullptr,
+ /*inputs =*/ nullptr,
+ /*logits =*/ nullptr,
/*loss_type =*/ loss_type,
/*build_type =*/ GGML_OPT_BUILD_TYPE_OPT,
/*opt_period =*/ 1,
return dst;
}
-static void ggml_opt_alloc_graph(ggml_opt_context_t opt_ctx, ggml_cgraph * graph) {
- GGML_ASSERT(graph);
- if (opt_ctx->allocated_graph == graph) {
- return;
- }
-
- ggml_backend_sched_reset(opt_ctx->backend_sched); // clear allocation of previous graph
-
- {
- ggml_init_params params = {
- /*.mem_size =*/ ggml_tensor_overhead() * GGML_DEFAULT_GRAPH_SIZE,
- /*.mem_buffer =*/ nullptr,
- /*.no_alloc =*/ true,
- };
- ggml_free(opt_ctx->ctx_copy);
- opt_ctx->ctx_copy = ggml_init(params);
- }
-
- opt_ctx->allocated_graph_copy = dup_graph(opt_ctx->ctx_copy, graph);
-
- ggml_backend_sched_alloc_graph(opt_ctx->backend_sched, opt_ctx->allocated_graph_copy);
- opt_ctx->allocated_graph = graph;
-}
-
-ggml_opt_context_t ggml_opt_init(struct ggml_opt_params params) {
- ggml_opt_context_t result = new struct ggml_opt_context;
- result->backend_sched = params.backend_sched;
- result->ctx_compute = params.ctx_compute;
- result->inputs = params.inputs;
- result->outputs = params.outputs;
- result->opt_period = params.opt_period;
- result->get_opt_pars = params.get_opt_pars;
- result->get_opt_pars_ud = params.get_opt_pars_ud;
-
- GGML_ASSERT(result->inputs->data && "the inputs must be allocated statically");
- GGML_ASSERT(result->opt_period >= 1);
-
- const bool accumulate = params.build_type == GGML_OPT_BUILD_TYPE_GRAD ||
- (params.build_type == GGML_OPT_BUILD_TYPE_OPT && result->opt_period > 1);
+static void ggml_opt_build(ggml_opt_context_t opt_ctx) {
+ GGML_ASSERT(opt_ctx->ctx_compute && "no compute context set, either use static graphs or set one with ggml_opt_prepare_alloc");
+ GGML_ASSERT((!opt_ctx->static_graphs || opt_ctx->inputs->data) && "when using static graphs the inputs must be allocated statically");
- ggml_set_input(result->inputs);
- ggml_set_output(result->outputs);
+ const bool accumulate = opt_ctx->build_type_alloc >= GGML_OPT_BUILD_TYPE_GRAD &&
+ !(opt_ctx->static_graphs && opt_ctx->build_type_alloc == GGML_OPT_BUILD_TYPE_OPT && opt_ctx->opt_period == 1);
- result->gf = ggml_new_graph_custom(result->ctx_compute, GGML_DEFAULT_GRAPH_SIZE, /*grads =*/ true); // Forward pass.
- ggml_build_forward_expand(result->gf, result->outputs);
+ ggml_set_input(opt_ctx->inputs);
+ ggml_set_output(opt_ctx->outputs);
int n_param = 0;
- for (int i = 0; i < result->gf->n_nodes; ++i) {
- if (result->gf->nodes[i]->flags & GGML_TENSOR_FLAG_PARAM) {
+ for (int i = 0; i < opt_ctx->gf->n_nodes; ++i) {
+ const struct ggml_tensor * node = opt_ctx->gf->nodes[i];
+ if (node->flags & GGML_TENSOR_FLAG_PARAM) {
n_param++;
}
+ GGML_ASSERT(!(node->flags & GGML_TENSOR_FLAG_LOSS) && "support for extra loss terms not implemented");
}
- {
+ if (!opt_ctx->ctx_static) {
// The static context is used for:
- // - gradients (1 tensor per param if using gradient accumulation)
+ // - gradients (1 per loss, 1 tensor per param if using gradient accumulation)
// - optimizer momenta (2 tensors per param)
- // - labels
- // - loss + its gradient (up to 5 tensors)
- // - pred
- // - ncorrect (2 tensors).
- const size_t tensors_per_param = (accumulate ? 1 : 0) + (params.build_type == GGML_OPT_BUILD_TYPE_OPT ? 2 : 0);
- const size_t size_meta = (tensors_per_param*n_param + 9) * ggml_tensor_overhead();
+ // - labels (if using static graphs)
+ // - loss (if using static graphs, up to 5 tensors)
+ // - pred (if using static graphs)
+ // - ncorrect (if using static graphs, 2 tensors).
+ constexpr size_t n_loss = 1;
+ const size_t tensors_per_param = (accumulate ? 1 : 0) +
+ (opt_ctx->build_type_alloc == GGML_OPT_BUILD_TYPE_OPT ? 2 : 0);
+ const size_t tensors_const = opt_ctx->static_graphs ? 9 : 0;
+ const size_t size_meta = (n_loss + tensors_per_param*n_param + tensors_const) * ggml_tensor_overhead();
struct ggml_init_params params = {
/*.mem_size =*/ size_meta,
/*.mem_buffer =*/ nullptr,
/*.no_alloc =*/ true,
};
- result->ctx_static = ggml_init(params);
+ opt_ctx->ctx_static = ggml_init(params);
}
+ GGML_ASSERT(opt_ctx->build_type <= opt_ctx->build_type_alloc);
+
{
- // The static cpu context is used for:
- // - optimizer parameters (1 for the entire context)
+ // The cpu context is allocated statically if using static graphs, dynamically otherwise.
+ // It is used for:
+ // - optimizer parameters (1 shared for all optimizer invocations)
const size_t size_meta = 1 * ggml_tensor_overhead();
struct ggml_init_params params = {
/*.mem_size =*/ size_meta,
/*.mem_buffer =*/ nullptr,
/*.no_alloc =*/ true,
};
- result->ctx_static_cpu = ggml_init(params);
+ ggml_free(opt_ctx->ctx_cpu);
+ opt_ctx->ctx_cpu = ggml_init(params);
+
+ ggml_backend_buffer_free(opt_ctx->buf_cpu);
+ opt_ctx->buf_cpu = nullptr;
}
+ struct ggml_context * ctx_results = opt_ctx->static_graphs ? opt_ctx->ctx_static : opt_ctx->ctx_compute;
- switch (params.loss_type) {
+ switch (opt_ctx->loss_type) {
case GGML_OPT_LOSS_TYPE_MEAN: {
- result->loss = ggml_sum(result->ctx_static, result->outputs);
- ggml_set_name(result->loss, "loss_sum");
- const float scale = 1.0f / (result->opt_period * ggml_nelements(result->outputs));
- result->loss = ggml_scale(result->ctx_static, result->loss, scale);
- ggml_set_name(result->loss, "loss_mean");
- result->loss_per_datapoint = true;
+ opt_ctx->loss = ggml_sum(ctx_results, opt_ctx->outputs);
+ ggml_set_name(opt_ctx->loss, "loss_sum");
+ const float scale = 1.0f / (opt_ctx->opt_period * ggml_nelements(opt_ctx->outputs));
+ opt_ctx->loss = ggml_scale(ctx_results, opt_ctx->loss, scale);
+ ggml_set_name(opt_ctx->loss, "loss_mean");
+ opt_ctx->loss_per_datapoint = true;
break;
}
case GGML_OPT_LOSS_TYPE_SUM: {
- result->loss = ggml_sum(result->ctx_static, result->outputs);
- ggml_set_name(result->loss, "loss_sum");
- result->loss_per_datapoint = false;
+ opt_ctx->loss = ggml_sum(ctx_results, opt_ctx->outputs);
+ ggml_set_name(opt_ctx->loss, "loss_sum");
+ opt_ctx->loss_per_datapoint = false;
break;
}
case GGML_OPT_LOSS_TYPE_CROSS_ENTROPY: {
- result->labels = ggml_dup_tensor(result->ctx_static, result->outputs);
- ggml_set_input(result->labels);
- ggml_set_name(result->labels, "labels");
- result->loss = ggml_cross_entropy_loss(result->ctx_static, result->outputs, result->labels);
- ggml_set_name(result->loss, "loss_cross_entropy");
- if (result->opt_period > 1) {
- result->loss = ggml_scale(result->ctx_static, result->loss, 1.0f / result->opt_period);
- ggml_set_name(result->loss, "loss_cross_entropy_scaled");
+ opt_ctx->labels = ggml_dup_tensor(ctx_results, opt_ctx->outputs);
+ ggml_set_input(opt_ctx->labels);
+ ggml_set_name(opt_ctx->labels, "labels");
+ opt_ctx->loss = ggml_cross_entropy_loss(ctx_results, opt_ctx->outputs, opt_ctx->labels);
+ ggml_set_name(opt_ctx->loss, "loss_cross_entropy");
+ if (opt_ctx->opt_period > 1) {
+ opt_ctx->loss = ggml_scale(ctx_results, opt_ctx->loss, 1.0f / opt_ctx->opt_period);
+ ggml_set_name(opt_ctx->loss, "loss_cross_entropy_scaled");
}
- result->loss_per_datapoint = true;
+ opt_ctx->loss_per_datapoint = true;
break;
}
case GGML_OPT_LOSS_TYPE_MEAN_SQUARED_ERROR: {
- result->labels = ggml_dup_tensor(result->ctx_static, result->outputs);
- ggml_set_input(result->labels);
- ggml_set_name(result->labels, "labels");
- result->loss = ggml_sub(result->ctx_static, result->outputs, result->labels);
- ggml_set_name(result->loss, "loss_error");
- result->loss = ggml_sqr(result->ctx_static, result->loss);
- ggml_set_name(result->loss, "loss_squared_error");
- result->loss = ggml_sum(result->ctx_static, result->loss);
- ggml_set_name(result->loss, "loss_sum_squared_error");
- const float scale = 1.0f / (result->opt_period * ggml_nelements(result->outputs));
- result->loss = ggml_scale(result->ctx_static, result->loss, scale);
- ggml_set_name(result->loss, "loss_mean_squared_error");
- result->loss_per_datapoint = true;
+ opt_ctx->labels = ggml_dup_tensor(ctx_results, opt_ctx->outputs);
+ ggml_set_input(opt_ctx->labels);
+ ggml_set_name(opt_ctx->labels, "labels");
+ opt_ctx->loss = ggml_sub(ctx_results, opt_ctx->outputs, opt_ctx->labels);
+ ggml_set_name(opt_ctx->loss, "loss_error");
+ opt_ctx->loss = ggml_sqr(ctx_results, opt_ctx->loss);
+ ggml_set_name(opt_ctx->loss, "loss_squared_error");
+ opt_ctx->loss = ggml_sum(ctx_results, opt_ctx->loss);
+ ggml_set_name(opt_ctx->loss, "loss_sum_squared_error");
+ const float scale = 1.0f / (opt_ctx->opt_period * ggml_nelements(opt_ctx->outputs));
+ opt_ctx->loss = ggml_scale(ctx_results, opt_ctx->loss, scale);
+ ggml_set_name(opt_ctx->loss, "loss_mean_squared_error");
+ opt_ctx->loss_per_datapoint = true;
break;
}
}
- ggml_set_output(result->loss);
- ggml_set_loss(result->loss);
- ggml_build_forward_expand(result->gf, result->loss);
-
- result->pred = ggml_argmax(result->ctx_static, result->outputs);
- ggml_set_name(result->pred, "pred");
- ggml_set_output(result->pred);
- ggml_build_forward_expand(result->gf, result->pred);
+ ggml_set_output(opt_ctx->loss);
+ ggml_set_loss(opt_ctx->loss);
+ ggml_build_forward_expand(opt_ctx->gf, opt_ctx->loss);
+
+ if (opt_ctx->loss_type == GGML_OPT_LOSS_TYPE_CROSS_ENTROPY) {
+ opt_ctx->pred = ggml_argmax(ctx_results, opt_ctx->outputs);
+ ggml_set_name(opt_ctx->pred, "pred");
+ ggml_set_output(opt_ctx->pred);
+ ggml_build_forward_expand(opt_ctx->gf, opt_ctx->pred);
+
+ opt_ctx->ncorrect = ggml_count_equal(ctx_results, opt_ctx->pred, ggml_argmax(ctx_results, opt_ctx->labels));
+ ggml_set_name(opt_ctx->ncorrect, "ncorrect");
+ ggml_set_output(opt_ctx->ncorrect);
+ ggml_build_forward_expand(opt_ctx->gf, opt_ctx->ncorrect);
+ }
- if (result->labels) {
- result->ncorrect = ggml_count_equal(result->ctx_static, result->pred, ggml_argmax(result->ctx_static, result->labels));
- ggml_set_name(result->ncorrect, "ncorrect");
- ggml_set_output(result->ncorrect);
- ggml_build_forward_expand(result->gf, result->ncorrect);
- } else {
- result->ncorrect = nullptr;
+ if (opt_ctx->buf_static) {
+ if (opt_ctx->build_type == GGML_OPT_BUILD_TYPE_FORWARD) {
+ return;
+ }
+ } else if (opt_ctx->build_type_alloc == GGML_OPT_BUILD_TYPE_FORWARD) {
+ opt_ctx->buf_static = ggml_backend_alloc_ctx_tensors(
+ opt_ctx->ctx_static, ggml_backend_sched_get_backend(opt_ctx->backend_sched, 0));
+ return;
}
- if (params.build_type == GGML_OPT_BUILD_TYPE_FORWARD) {
- result->buf_static = ggml_backend_alloc_ctx_tensors(result->ctx_static, ggml_backend_sched_get_backend(result->backend_sched, 0));
- return result;
+ if (opt_ctx->grad_accs.empty()) {
+ GGML_ASSERT(opt_ctx->build_type_alloc >= GGML_OPT_BUILD_TYPE_GRAD);
+
+ const int n_nodes = opt_ctx->gf->n_nodes;
+ opt_ctx->grad_accs.resize(n_nodes);
+ for (int i = 0; i < n_nodes; ++i) {
+ ggml_tensor * node = opt_ctx->gf->nodes[i];
+ if ((accumulate && (node->flags & GGML_TENSOR_FLAG_PARAM)) || (node->flags & GGML_TENSOR_FLAG_LOSS)) {
+ opt_ctx->grad_accs[i] = ggml_new_tensor(opt_ctx->ctx_static, GGML_TYPE_F32, GGML_MAX_DIMS, node->ne);
+ } else {
+ opt_ctx->grad_accs[i] = nullptr;
+ }
+ }
+
+ if (opt_ctx->build_type_alloc >= GGML_OPT_BUILD_TYPE_OPT) {
+ opt_ctx->grad_m.resize(n_nodes);
+ opt_ctx->grad_v.resize(n_nodes);
+ for (int i = 0; i < n_nodes; ++i) {
+ ggml_tensor * node = opt_ctx->gf->nodes[i];
+ if (node->flags & GGML_TENSOR_FLAG_PARAM) {
+ opt_ctx->grad_m[i] = ggml_new_tensor(opt_ctx->ctx_static, GGML_TYPE_F32, GGML_MAX_DIMS, node->ne);
+ opt_ctx->grad_v[i] = ggml_new_tensor(opt_ctx->ctx_static, GGML_TYPE_F32, GGML_MAX_DIMS, node->ne);
+ } else {
+ opt_ctx->grad_m[i] = nullptr;
+ opt_ctx->grad_v[i] = nullptr;
+ }
+ }
+ }
}
// gb_grad == graph backward gradients, forward pass, then backward pass to calculate gradients.
- result->gb_grad = ggml_graph_dup(result->ctx_compute, result->gf);
- ggml_build_backward_expand(result->ctx_static, result->ctx_compute, result->gb_grad, accumulate);
+ opt_ctx->gb_grad = ggml_graph_dup(opt_ctx->ctx_compute, opt_ctx->gf, /*force_grads =*/ true);
+ ggml_build_backward_expand(opt_ctx->ctx_compute, opt_ctx->gb_grad, opt_ctx->grad_accs.data());
- if (params.build_type == GGML_OPT_BUILD_TYPE_GRAD) {
- result->buf_static = ggml_backend_alloc_ctx_tensors(result->ctx_static, ggml_backend_sched_get_backend(result->backend_sched, 0));
- ggml_graph_reset(result->gb_grad);
- return result;
+ if (opt_ctx->buf_static) {
+ if (opt_ctx->build_type == GGML_OPT_BUILD_TYPE_GRAD) {
+ return;
+ }
+ } else if (opt_ctx->build_type_alloc == GGML_OPT_BUILD_TYPE_GRAD) {
+ opt_ctx->buf_static = ggml_backend_alloc_ctx_tensors(opt_ctx->ctx_static, ggml_backend_sched_get_backend(opt_ctx->backend_sched, 0));
+ ggml_graph_reset(opt_ctx->gb_grad);
}
- GGML_ASSERT(params.build_type == GGML_OPT_BUILD_TYPE_OPT);
+ GGML_ASSERT(opt_ctx->build_type_alloc == GGML_OPT_BUILD_TYPE_OPT);
// gb_opt == graph backward optimize, forward pass, then backward pass to calculate gradients, then optimizer step.
- result->gb_opt = ggml_graph_dup(result->ctx_compute, result->gb_grad);
+ opt_ctx->gb_opt = ggml_graph_dup(opt_ctx->ctx_compute, opt_ctx->gb_grad, /*force_grads =*/ true);
- result->adamw_params = ggml_new_tensor_1d(result->ctx_static_cpu, GGML_TYPE_F32, 7);
- ggml_set_input(result->adamw_params);
- ggml_set_name(result->adamw_params, "adamw_params");
+ opt_ctx->adamw_params = ggml_new_tensor_1d(opt_ctx->ctx_cpu, GGML_TYPE_F32, 7);
+ ggml_set_input(opt_ctx->adamw_params);
+ ggml_set_name(opt_ctx->adamw_params, "adamw_params");
- for (int i = result->gf->n_nodes-1; i >= 0; --i) {
- struct ggml_tensor * node = result->gb_opt->nodes[i];
- struct ggml_tensor * grad = ggml_graph_get_grad(result->gb_opt, node);
+ for (int i = opt_ctx->gf->n_nodes-1; i >= 0; --i) {
+ struct ggml_tensor * node = opt_ctx->gb_opt->nodes[i];
+ struct ggml_tensor * grad = ggml_graph_get_grad(opt_ctx->gb_opt, node);
- if (node->flags & GGML_TENSOR_FLAG_PARAM) {
- struct ggml_tensor * m = ggml_dup_tensor(result->ctx_static, node);
- struct ggml_tensor * v = ggml_dup_tensor(result->ctx_static, node);
- struct ggml_tensor * opt_step = ggml_opt_step_adamw(result->ctx_compute, node, grad, m, v, result->adamw_params);
- ggml_build_forward_expand(result->gb_opt, opt_step);
+ if (grad && (node->flags & GGML_TENSOR_FLAG_PARAM)) {
+ struct ggml_tensor * m = opt_ctx->grad_m[i];
+ struct ggml_tensor * v = opt_ctx->grad_v[i];
+ struct ggml_tensor * opt_step = ggml_opt_step_adamw(opt_ctx->ctx_compute, node, grad, m, v, opt_ctx->adamw_params);
+
+ ggml_set_name(m, (std::string("AdamW m for ") + std::string(node->name)).c_str());
+ ggml_set_name(v, (std::string("AdamW v for ") + std::string(node->name)).c_str());
+ ggml_set_name(opt_step, (std::string("AdamW step for ") + std::string(node->name)).c_str());
+
+ ggml_build_forward_expand(opt_ctx->gb_opt, opt_step);
}
}
- result->buf_static = ggml_backend_alloc_ctx_tensors(
- result->ctx_static, ggml_backend_sched_get_backend(result->backend_sched, 0));
+ if (!opt_ctx->buf_static) {
+ opt_ctx->buf_static = ggml_backend_alloc_ctx_tensors(
+ opt_ctx->ctx_static, ggml_backend_sched_get_backend(opt_ctx->backend_sched, 0));
+ ggml_graph_reset(opt_ctx->gb_opt);
+ }
- result->buf_static_cpu = ggml_backend_alloc_ctx_tensors_from_buft(result->ctx_static_cpu, ggml_backend_cpu_buffer_type());
+ opt_ctx->buf_cpu = ggml_backend_alloc_ctx_tensors_from_buft(opt_ctx->ctx_cpu, ggml_backend_cpu_buffer_type());
+}
- ggml_graph_reset(result->gb_opt);
+ggml_opt_context_t ggml_opt_init(struct ggml_opt_params params) {
+ ggml_opt_context_t result = new struct ggml_opt_context;
+ result->backend_sched = params.backend_sched;
+ result->ctx_compute = params.ctx_compute;
+ result->loss_type = params.loss_type;
+ result->build_type = params.build_type;
+ result->build_type_alloc = params.build_type;
+ result->inputs = params.inputs;
+ result->outputs = params.outputs;
+ result->opt_period = params.opt_period;
+ result->get_opt_pars = params.get_opt_pars;
+ result->get_opt_pars_ud = params.get_opt_pars_ud;
+
+ GGML_ASSERT(result->opt_period >= 1);
+
+ result->static_graphs = result->ctx_compute;
+
+ if (!result->static_graphs) {
+ GGML_ASSERT(!result->inputs);
+ GGML_ASSERT(!result->outputs);
+ return result;
+ }
+
+ GGML_ASSERT(result->inputs);
+ GGML_ASSERT(result->outputs);
+
+ result->gf = ggml_new_graph_custom(result->ctx_compute, GGML_DEFAULT_GRAPH_SIZE, /*grads =*/ true); // Forward pass.
+ ggml_build_forward_expand(result->gf, result->outputs);
+
+ ggml_opt_build(result);
return result;
}
return;
}
ggml_backend_buffer_free(opt_ctx->buf_static);
- ggml_backend_buffer_free(opt_ctx->buf_static_cpu);
+ ggml_backend_buffer_free(opt_ctx->buf_cpu);
ggml_free(opt_ctx->ctx_static);
- ggml_free(opt_ctx->ctx_static_cpu);
+ ggml_free(opt_ctx->ctx_cpu);
delete opt_ctx;
}
// ====== Computation ======
-static void ggml_opt_eval_graph(ggml_opt_context_t opt_ctx, ggml_cgraph * graph, ggml_opt_result * result) {
- if (graph != opt_ctx->gf) {
+void ggml_opt_prepare_alloc(
+ ggml_opt_context_t opt_ctx,
+ struct ggml_context * ctx_compute,
+ struct ggml_cgraph * gf,
+ struct ggml_tensor * inputs,
+ struct ggml_tensor * outputs) {
+ GGML_ASSERT(!opt_ctx->static_graphs);
+ opt_ctx->ctx_compute = ctx_compute;
+ opt_ctx->gf = gf;
+ opt_ctx->inputs = inputs;
+ opt_ctx->outputs = outputs;
+}
+
+void ggml_opt_alloc(ggml_opt_context_t opt_ctx, bool backward) {
+ GGML_ASSERT(!opt_ctx->eval_ready);
+ if (opt_ctx->build_type == GGML_OPT_BUILD_TYPE_OPT && opt_ctx->opt_period > 1 && opt_ctx->opt_i == 0) {
+ ggml_graph_reset(opt_ctx->gb_grad);
+ }
+ if (backward) {
+ const int32_t opt_i_next = (opt_ctx->opt_i + 1) % opt_ctx->opt_period;
+ opt_ctx->build_type = opt_i_next == 0 ? GGML_OPT_BUILD_TYPE_OPT : GGML_OPT_BUILD_TYPE_GRAD;
+ } else {
+ opt_ctx->build_type = GGML_OPT_BUILD_TYPE_FORWARD;
+ }
+
+ if (!opt_ctx->static_graphs) {
+ ggml_opt_build(opt_ctx);
+ }
+
+ struct ggml_cgraph * graph = nullptr;
+ switch (opt_ctx->build_type) {
+ case GGML_OPT_BUILD_TYPE_FORWARD: {
+ graph = opt_ctx->gf;
+ } break;
+ case GGML_OPT_BUILD_TYPE_GRAD: {
+ graph = opt_ctx->gb_grad;
+ } break;
+ case GGML_OPT_BUILD_TYPE_OPT: {
+ graph = opt_ctx->gb_opt;
+ } break;
+ }
+ GGML_ASSERT(graph);
+
+ if (opt_ctx->allocated_graph == graph) {
+ opt_ctx->eval_ready = true;
+ return;
+ }
+
+ ggml_backend_sched_reset(opt_ctx->backend_sched); // clear allocation of previous graph
+
+ if (opt_ctx->static_graphs) {
+ ggml_init_params params = {
+ /*.mem_size =*/ graph->size*ggml_tensor_overhead() + ggml_graph_overhead_custom(graph->size, graph->grads),
+ /*.mem_buffer =*/ nullptr,
+ /*.no_alloc =*/ true,
+ };
+ ggml_free(opt_ctx->ctx_copy);
+ opt_ctx->ctx_copy = ggml_init(params);
+
+ opt_ctx->allocated_graph_copy = dup_graph(opt_ctx->ctx_copy, graph);
+ } else {
+ opt_ctx->allocated_graph_copy = graph;
+ }
+
+ ggml_backend_sched_alloc_graph(opt_ctx->backend_sched, opt_ctx->allocated_graph_copy);
+ opt_ctx->allocated_graph = graph;
+
+ opt_ctx->eval_ready = true;
+}
+
+void ggml_opt_eval(ggml_opt_context_t opt_ctx, ggml_opt_result_t result) {
+ GGML_ASSERT(opt_ctx->eval_ready);
+ if (opt_ctx->allocated_graph == opt_ctx->gb_opt) {
struct ggml_opt_optimizer_params opt_pars = opt_ctx->get_opt_pars(opt_ctx->get_opt_pars_ud);
GGML_ASSERT(opt_pars.adamw.alpha > 0.0f);
adamw_par_data[6] = beta2h;
}
- ggml_opt_alloc_graph(opt_ctx, graph);
ggml_backend_sched_graph_compute(opt_ctx->backend_sched, opt_ctx->allocated_graph_copy);
opt_ctx->iter += opt_ctx->allocated_graph == opt_ctx->gb_opt;
+ opt_ctx->opt_i = (opt_ctx->opt_i + 1) % opt_ctx->opt_period;
+
+ if (!opt_ctx->static_graphs) {
+ opt_ctx->gf = nullptr;
+ opt_ctx->gb_grad = nullptr;
+ opt_ctx->gb_opt = nullptr;
+ opt_ctx->allocated_graph = nullptr;
+ opt_ctx->allocated_graph_copy = nullptr;
+ }
+
+ opt_ctx->eval_ready = false;
if (!result) {
return;
ggml_backend_tensor_get(opt_ctx->loss, &loss, 0, ggml_nbytes(opt_ctx->loss));
result->loss.push_back(loss);
- GGML_ASSERT(opt_ctx->pred->type == GGML_TYPE_I32);
- std::vector<int32_t> pred(ndata);
- ggml_backend_tensor_get(opt_ctx->pred, pred.data(), 0, ggml_nbytes(opt_ctx->pred));
- result->pred.insert(result->pred.end(), pred.begin(), pred.end());
+ if (opt_ctx->pred) {
+ GGML_ASSERT(opt_ctx->pred->type == GGML_TYPE_I32);
+ std::vector<int32_t> pred(ndata);
+ ggml_backend_tensor_get(opt_ctx->pred, pred.data(), 0, ggml_nbytes(opt_ctx->pred));
+ result->pred.insert(result->pred.end(), pred.begin(), pred.end());
+ }
- if (!opt_ctx->labels || result->ncorrect < 0) {
+ if (!opt_ctx->ncorrect || result->ncorrect < 0) {
result->ncorrect = -1;
return;
}
result->ncorrect += ncorrect;
}
-void ggml_opt_forward(ggml_opt_context_t opt_ctx, ggml_opt_result * result) {
- ggml_opt_eval_graph(opt_ctx, opt_ctx->gf, result);
-}
-
-void ggml_opt_forward_backward(ggml_opt_context_t opt_ctx, ggml_opt_result * result) {
- if (opt_ctx->opt_period == 1) {
- ggml_opt_eval_graph(opt_ctx, opt_ctx->gb_opt, result);
- return;
- }
-
- const int32_t opt_i_next = (opt_ctx->opt_i + 1) % opt_ctx->opt_period;
- if (opt_i_next == 0) {
- ggml_opt_eval_graph(opt_ctx, opt_ctx->gb_opt, result);
- ggml_opt_reset(opt_ctx, /*optimizer =*/ false);
- } else {
- ggml_opt_eval_graph(opt_ctx, opt_ctx->gb_grad, result);
- }
- opt_ctx->opt_i = opt_i_next;
-}
-
// ====== High-Level Functions ======
void ggml_opt_epoch(
int64_t ibatch = 0;
int64_t t_loop_start = ggml_time_us();
for (; ibatch < ibatch_split; ++ibatch) {
+ ggml_opt_alloc(opt_ctx, /*backward =*/ true);
ggml_opt_dataset_get_batch(dataset, inputs, labels, ibatch);
- ggml_opt_forward_backward(opt_ctx, result_train);
+ ggml_opt_eval(opt_ctx, result_train);
if (callback_train) {
callback_train(true, opt_ctx, dataset, result_train, ibatch+1, ibatch_split, t_loop_start);
}
}
t_loop_start = ggml_time_us();
for (; ibatch < nbatches; ++ibatch) {
+ ggml_opt_alloc(opt_ctx, /*backward =*/ false);
ggml_opt_dataset_get_batch(dataset, inputs, labels, ibatch);
- ggml_opt_forward(opt_ctx, result_eval);
+ ggml_opt_eval(opt_ctx, result_eval);
if (callback_eval) {
callback_eval(false, opt_ctx, dataset, result_eval, ibatch+1-ibatch_split, nbatches-ibatch_split, t_loop_start);
}
int64_t t_start_us) {
fprintf(stderr, "%s[", train ? "train: " : "val: ");
- constexpr int64_t bar_length = 25;
+ // The progress bar consists of partially filled blocks, unicode has 8 separate fill levels.
+ constexpr int64_t bar_length = 8;
+ const int64_t ibatch8 = 8 * ibatch;
for (int64_t j = 0; j < bar_length; ++j) {
- const int64_t ibatch_j = ibatch_max * j/bar_length;
- if (ibatch_j < ibatch) {
- fprintf(stderr, "=");
- } else if (ibatch_max * (j - 1)/bar_length < ibatch) {
- fprintf(stderr, ">");
+ if (ibatch_max * (8*j + 8) / bar_length < ibatch8) {
+ fprintf(stderr, "\u2588"); // full block
+ } else if (ibatch_max * (8*j + 7) / bar_length < ibatch8) {
+ fprintf(stderr, "\u2589"); // 7/8 filled
+ } else if (ibatch_max * (8*j + 6) / bar_length < ibatch8) {
+ fprintf(stderr, "\u258A"); // 6/8 filled
+ } else if (ibatch_max * (8*j + 5) / bar_length < ibatch8) {
+ fprintf(stderr, "\u258B"); // 5/8 filled
+ } else if (ibatch_max * (8*j + 4) / bar_length < ibatch8) {
+ fprintf(stderr, "\u258C"); // 4/8 filled
+ } else if (ibatch_max * (8*j + 3) / bar_length < ibatch8) {
+ fprintf(stderr, "\u258D"); // 3/8 filled
+ } else if (ibatch_max * (8*j + 2) / bar_length < ibatch8) {
+ fprintf(stderr, "\u258E"); // 2/8 filled
+ } else if (ibatch_max * (8*j + 1) / bar_length < ibatch8) {
+ fprintf(stderr, "\u258F"); // 1/8 filled
} else {
fprintf(stderr, " ");
}
const int64_t t_eta_m = t_eta_s / 60;
t_eta_s -= t_eta_m * 60;
- fprintf(stderr, "| data=%06" PRId64 "/%06" PRId64 ", loss=%.6lf+-%.6lf, accuracy=%.2lf+-%.2lf%%, "
- "t=%02" PRId64 ":%02" PRId64 ":%02" PRId64 ", ETA=%02" PRId64 ":%02" PRId64 ":%02" PRId64 "]\r",
+ fprintf(stderr, "] data=%07" PRId64 "/%07" PRId64 " loss=%.5lf±%.5lf acc=%.2lf±%.2lf%% "
+ "t=%02" PRId64 ":%02" PRId64 ":%02" PRId64 " ETA=%02" PRId64 ":%02" PRId64 ":%02" PRId64 " \r",
idata, idata_max, loss, loss_unc, 100.0*accuracy, 100.0*accuracy_unc,
t_ibatch_h, t_ibatch_m, t_ibatch_s, t_eta_h, t_eta_m, t_eta_s);
if (ibatch == ibatch_max) {
int64_t epoch = 1;
- ggml_opt_params params = ggml_opt_default_params(backend_sched, ctx_compute, inputs, outputs, loss_type);
+ ggml_opt_params params = ggml_opt_default_params(backend_sched, loss_type);
+ params.ctx_compute = ctx_compute;
+ params.inputs = inputs;
+ params.outputs = outputs;
params.opt_period = opt_period;
params.get_opt_pars = get_opt_pars;
params.get_opt_pars_ud = &epoch;
overview / pkg / ggml / sources / whisper.cpp / commitdiff