Skip to content

dspy.configure_cache

dspy.configure_cache(enable_disk_cache: bool | None = True, enable_memory_cache: bool | None = True, disk_cache_dir: str | None = DISK_CACHE_DIR, disk_size_limit_bytes: int | None = DISK_CACHE_LIMIT, memory_max_entries: int | None = 1000000)

Configure the cache for DSPy.

Parameters:

Name Type Description Default
enable_disk_cache bool | None

Whether to enable on-disk cache.

 True
enable_memory_cache bool | None

Whether to enable in-memory cache.

 True
disk_cache_dir str | None

The directory to store the on-disk cache.

 DISK_CACHE_DIR
disk_size_limit_bytes int | None

The size limit of the on-disk cache.

 DISK_CACHE_LIMIT
memory_max_entries int | None

The maximum number of entries in the in-memory cache.

 1000000
Source code in dspy/clients/__init__.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
def configure_cache(
    enable_disk_cache: bool | None = True,
    enable_memory_cache: bool | None = True,
    disk_cache_dir: str | None = DISK_CACHE_DIR,
    disk_size_limit_bytes: int | None = DISK_CACHE_LIMIT,
    memory_max_entries: int | None = 1000000,
):
    """Configure the cache for DSPy.

    Args:
        enable_disk_cache: Whether to enable on-disk cache.
        enable_memory_cache: Whether to enable in-memory cache.
        disk_cache_dir: The directory to store the on-disk cache.
        disk_size_limit_bytes: The size limit of the on-disk cache.
        memory_max_entries: The maximum number of entries in the in-memory cache.
    """

    DSPY_CACHE = Cache(
        enable_disk_cache,
        enable_memory_cache,
        disk_cache_dir,
        disk_size_limit_bytes,
        memory_max_entries,
    )

    import dspy
    # Update the reference to point to the new cache
    dspy.cache = DSPY_CACHE

:::