Function loadResourceFile

packages/transformers/src/utils/hub.js:245–474

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

 * @returns {Promise<string|Uint8Array|null>} 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 loadResourceFile(
    path_or_repo_id,
    filename,
    fatal = true,
    options = {},
    return_path = false,
    cache = null,
) {
    const { requestURL, localPath, remoteURL, proposedCacheKey, validModelId } = buildResourcePaths(
        path_or_repo_id,
        filename,
        options,
        cache,
    );

    /** @type {string} */
    let cacheKey;

    // Whether to cache the final response in the end.
    let toCacheResponse = false;

    /** @type {Response|import('./hub/FileResponse.js').FileResponse|undefined|string} */
    let response;

    // Check cache
    response = await checkCachedResource(cache, localPath, proposedCacheKey);

    const cacheHit = response !== undefined;
    if (cacheHit) {
        cacheKey = proposedCacheKey;
    } else {
        // Caching not available, or file is not cached, so we perform the request

        if (env.allowLocalModels) {
            // Accessing local models is enabled, so we try to get the file locally.
            // If request is a valid HTTP URL, we skip the local file check. Otherwise, we try to get the file locally.
            const isURL = isValidUrl(requestURL, ['http:', 'https:']);
            if (!isURL) {
                try {
                    response = await getFile(localPath);
                    cacheKey = localPath; // Update the cache key to be the local path
                } catch (e) {
                    // Something went wrong while trying to get the file locally.
                    // NOTE: error handling is done in the next step (since `response` will be undefined)
                    logger.warn(`Unable to load from local path "${localPath}": "${e}"`);
                }
            } else if (options.local_files_only) {
                throw new Error(`\`local_files_only=true\`, but attempted to load a remote file from: ${requestURL}.`);
            } else if (!env.allowRemoteModels) {
                throw new Error(
                    `\`env.allowRemoteModels=false\`, but attempted to load a remote file from: ${requestURL}.`,
                );
            }
        }

        if (response === undefined || (typeof response !== 'string' && response.status === 404)) {
            // File not found locally. This means either:
            // - The user has disabled local file access (`env.allowLocalModels=false`)