Function getModelFile

packages/transformers/src/utils/hub.js:494–537

(path_or_repo_id, filename, fatal = true, options = {}, return_path = false)

 * @returns {Promise<string|Uint8Array>} A Promise that resolves with the file content as a Uint8Array if `return_path` is false, or the file path as a string if `return_path` is true.
 */
export async function getModelFile(path_or_repo_id, filename, fatal = true, options = {}, return_path = false) {
    if (!env.allowLocalModels) {
        // User has disabled local models, so we just make sure other settings are correct.

        if (options.local_files_only) {
            throw Error(
                'Invalid configuration detected: local models are disabled (`env.allowLocalModels=false`) but you have requested to only use local models (`local_files_only=true`).',
            );
        } else if (!env.allowRemoteModels) {
            throw Error(
                'Invalid configuration detected: both local and remote models are disabled. Fix by setting `env.allowLocalModels` or `env.allowRemoteModels` to `true`.',
            );
        }
    }

    dispatchCallback(options.progress_callback, {
        status: 'initiate',
        name: path_or_repo_id,
        file: filename,
    });

    // Deduplicate concurrent loads of the same file so progress events are
    // only emitted by a single download. Without this, parallel callers
    // (e.g. tokenizer + processor in pipeline()) would race on the same file
    // and produce interleaved progress that breaks monotonic progress_total.
    const key = `${path_or_repo_id}::${filename}`;
    let pending = INFLIGHT_LOADS.get(key);
    if (!pending) {
        /** @type {import('./cache.js').CacheInterface | null} */
        const cache = await getCache(options?.cache_dir);
        pending = loadResourceFile(path_or_repo_id, filename, fatal, options, return_path, cache).then(
            (result) => {
                INFLIGHT_LOADS.delete(key);
                return result;
            },
            (err) => {
                INFLIGHT_LOADS.delete(key);
                throw err;
            },
        );
        INFLIGHT_LOADS.set(key, pending);
    }
    return await pending;
}

/**
 * Fetches a text file from a given path and file name.