[GraphBolt] Update CPUCachedFeature docstring. (#7646)

This commit is contained in:
Muhammed Fatih BALIN
2024-08-03 11:12:51 -04:00
committed by GitHub
parent c5cace79e9
commit 683a25a8ec

View File

@@ -25,7 +25,10 @@ class CPUCachedFeature(Feature):
fallback_feature : Feature
The fallback feature.
max_cache_size_in_bytes : int
The capacity of the cache in bytes.
The capacity of the cache in bytes. The size should be a few factors
larger than the size of each read request. Otherwise, the caching policy
will hang due to all cache entries being read and/or write locked,
resulting in a deadlock.
policy : str
The cache eviction policy algorithm name. See gb.impl.CPUFeatureCache
for the list of available policies.