llama.cpp/tests/test-ggml-tune.c

#include "ggml-tune.h"
#include "ggml.h"

#include <string.h>

#define UNUSED(x) (void)(x)

static int bench(void);
static int estimate_time_non_zero_NK(void);

static void init_params(struct ggml_mulmat_tune_params *params,
                        enum ggml_ftype ftype, int m_num, int n_threads) {
    *params = (struct ggml_mulmat_tune_params){
        .model =
            (struct ggml_mulmat_tune_model){
                .name = "xB", // fake model name
                .ftype = ftype,
                .n_vocab = 4096,
                .n_embd = 1024,
                .n_ff = 2048,
                .n_rot = 128,
            },
        .m_num = m_num,
        .n_pass = 1,
        .n_threads = n_threads,
        .progress = false,
        .output_console = true,
        .fname = NULL};
}

int main(void) {
    int rv = bench();
    if (rv != 0) {
        return rv;
    }

    printf("\n");

    rv = estimate_time_non_zero_NK();
    if (rv != 0) {
        return rv;
    }
    printf("\n");

    return 0;
}

static int bench(void) {
    if (!ggml_cpu_has_blas()) {
        printf("[test-ggml-tune] skipped because no BLAS\n");
        return 0;
    }

    {
        struct ggml_init_params init_params = {
            /*.mem_size   =*/1,
            /*.mem_buffer =*/NULL,
            /*.no_alloc   =*/0,
        };
        struct ggml_context *ctx = ggml_init(init_params);
        GGML_ASSERT(ctx);
        ggml_free(ctx);
    }

    // F32: ggml_opencl: ggml_cl_h2d_tensor_2d(queue, d_X, 0, src0, i03, i02,
    // NULL) error -30 at /Users/mqy/tools/AI/llama.cpp/ggml-opencl.cpp:838
    enum ggml_ftype ftypes[] = {
        // GGML_FTYPE_ALL_F32,
        // GGML_FTYPE_MOSTLY_F16,
        GGML_FTYPE_MOSTLY_Q4_0,
#if defined(GGML_USE_K_QUANTS)
        GGML_FTYPE_MOSTLY_Q4_K,
#endif
    };

    int n_ftypes = sizeof(ftypes) / sizeof(ftypes[0]);

    const int m_num = 4;

    // Don't use n_threads larger than 2 because Github build hosts has limited
    // resource quota.
    int threads_arr[] = {1, 2};
    int thread_arr_len = sizeof(threads_arr) / sizeof(threads_arr[0]);

    int n_passed = 0;
    int n_tests = 0;

    for (int i = 0; i < n_ftypes; i++) {
        for (int j = 0; j < thread_arr_len; j++) {
            printf("\n");

            int n_threads = threads_arr[j];
            struct ggml_mulmat_tune tune;

            struct ggml_mulmat_tune_params params;
            memset(&params, 0, sizeof(struct ggml_mulmat_tune_params));
            init_params(&params, ftypes[i], m_num, n_threads);

            ++n_tests;
            bool ok = ggml_mulmat_tune_bench(&tune, &params);
            if (ok) {
                ++n_passed;
            }
            ggml_mulmat_tune_free(&tune);
        }
    }

    printf("[test-ggml-tune] %d / %d passed\n", n_passed, n_tests);
    return (n_passed == n_tests) ? 0 : 1;
}

// implement `ggml_task_profiles_provider`
static int
ggml_task_profiles_mock_qxx_provider(struct ggml_tensor *node,
                                     struct ggml_task_profile *profiles) {
    UNUSED(node);
    profiles[0].id = 1;
    profiles[0].stages[0].valid = true;
    profiles[0].stages[1].valid = true;

    profiles[0].id = 2;
    profiles[1].stages[0].valid = true;
    profiles[1].stages[1].valid = true;

    return 2;
}

int estimate_time_non_zero_NK(void) {
    printf("[test-ggml-tune] %s\n", __func__);

    struct test_data_t {
        int M;
        int time[3]; // 3 profiles.
    };

    struct ggml_mulmat_tune tune;

    enum ggml_ftype ftype = GGML_FTYPE_MOSTLY_Q4_0;
    const int m_num = 2;
    const int n_threads = 1; // useless.

    struct ggml_mulmat_tune_params params;
    init_params(&params, ftype, m_num, n_threads);

    ggml_mulmat_tune_init(&tune, &params, ggml_task_profiles_mock_qxx_provider);

    struct ggml_mulmat_tune_shape *shape = NULL;
    for (int i = 0; i < tune.n_shapes; i++) {
        if (tune.shapes[i].N > 0 && tune.shapes[i].K > 0) {
            shape = &tune.shapes[i];
            break;
        }
    }
    GGML_ASSERT(shape);
    GGML_ASSERT(shape->n_profiles == 2);
    GGML_ASSERT(ggml_is_quantized(shape->src0_type));

    printf("[test-ggml-tune] %s, shape: N: %d, K: %d, n_profiles: %d\n",
           __func__, shape->N, shape->K, shape->n_profiles);

    {
        shape->items[0] =
            (struct ggml_mulmat_tune_m){.M = 2, .stages_time = {2, 4, 0}};
        shape->items[1] =
            (struct ggml_mulmat_tune_m){.M = 4, .stages_time = {4, 8, 0}};

        shape->items[2] =
            (struct ggml_mulmat_tune_m){.M = 2, .stages_time = {4, 4, 0}};
        shape->items[3] =
            (struct ggml_mulmat_tune_m){.M = 4, .stages_time = {4, 4, 0}};
    }

    const struct test_data_t test_data[] = {
        {
            .M = 1, // out of range
            .time = {3, 8},
        },
        {
            .M = 2,
            .time = {6, 8},
        },
        {
            .M = 3,
            .time = {9, 8},
        },
        {
            .M = 4,
            .time = {12, 8},
        },
        {
            .M = 5, // out of range
            .time = {15, 8},
        },
    };

    int n_tests = (int)(sizeof(test_data) / sizeof(struct test_data_t));

    struct ggml_mulmat_tune_time profile_time[GGML_MAX_TASK_PROFILES];
    size_t profile_time_sz =
        sizeof(struct ggml_mulmat_tune_time) * GGML_MAX_TASK_PROFILES;

    int n_passed = 0;
    for (int i = 0; i < n_tests; i++) {
        memset(profile_time, 0, profile_time_sz);
        const struct test_data_t *e = &test_data[i];

        const struct ggml_mulmat_tune_shape *matched_shape =
            ggml_mulmat_tune_get_shape(&tune, shape->N, shape->K,
                                       shape->src0_type, shape->src1_type);
        GGML_ASSERT(matched_shape);
        GGML_ASSERT(matched_shape == shape);

        ggml_mulmat_tune_estimate_time(matched_shape, e->M, profile_time);

        for (int j = 0; j < shape->n_profiles; j++) {
            int actual = profile_time[j].total_time;
            int expect = e->time[j];
            if (expect != actual) {
                fprintf(stderr,
                        "test fail. i: %d, j: %d, M: %d, expect: "
                        "%d, actual: %d\n",
                        i, j, e->M, expect, actual);
            } else {
                ++n_passed;
            }
        }
    }

    n_tests *= shape->n_profiles;
    printf("%2d of %2d pass\n", n_passed, n_tests);

    ggml_mulmat_tune_free(&tune);

    return n_passed == n_tests ? 0 : 1;
}