Class ModelFileSystemCache

modelscope/hub/utils/caching.py:161–390

Local cache file layout cache_root/owner/model_name/individual cached files and cache index file '.mcs' Save only one version for each file.

class ModelFileSystemCache(FileSystemCache):
    """Local cache file layout
       cache_root/owner/model_name/individual cached files and cache index file '.mcs'
       Save only one version for each file.
    """

    def __init__(self, cache_root, owner=None, name=None):
        """Put file to the cache
        Args:
            cache_root(`str`): The modelscope local cache root(default: ~/.cache/modelscope/hub)
            owner(`str`): The model owner.
            name('str'): The name of the model
        Returns:
        Raises:
            None
        <Tip>
            model_id = {owner}/{name}
        </Tip>
        """
        if owner is None or name is None:
            # get model meta from
            super().__init__(os.path.join(cache_root))
            self.load_model_meta()
        else:
            super().__init__(os.path.join(cache_root, owner, name))
            self.model_meta = {
                FileSystemCache.MODEL_META_MODEL_ID: '%s/%s' % (owner, name)
            }
            self.save_model_meta()
        self.cached_model_revision = self.load_model_version()

    def load_model_meta(self):
        meta_file_path = os.path.join(self.cache_root_location,
                                      FileSystemCache.MODEL_META_FILE_NAME)
        if os.path.exists(meta_file_path):
            try:
                with open(meta_file_path, 'rb') as f:
                    data = pickle.load(f)
                if isinstance(data, dict):
                    self.model_meta = data
                    return
                logger.warning('Model meta %s has unexpected type, resetting.',
                               meta_file_path)
            except Exception as e:
                logger.warning('Failed to load model meta %s: %s. Resetting.',
                               meta_file_path, e)
                try:
                    os.replace(meta_file_path, meta_file_path + '.corrupted')
                except OSError:
                    pass
        self.model_meta = {FileSystemCache.MODEL_META_MODEL_ID: 'unknown'}

    def load_model_version(self):
        model_version_file_path = os.path.join(
            self.cache_root_location, FileSystemCache.MODEL_VERSION_FILE_NAME)
        if os.path.exists(model_version_file_path):
            with open(model_version_file_path, 'r') as f:
                return f.read().strip()