From 68268dffc7e6f913ff691424d77ea852d89e08b7 Mon Sep 17 00:00:00 2001 From: haochengxia Date: Tue, 5 Aug 2025 10:42:02 +0000 Subject: [PATCH] Fix: refine comments in example --- README.md | 2 +- docs/src/en/getting_started/quickstart.md | 2 +- examples/basic_usage.py | 11 +++++++++-- 3 files changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f313bd7..c93eb4d 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,7 @@ cache = lcs.S3FIFO( req_miss_ratio, byte_miss_ratio = cache.process_trace(reader) print(f"Request miss ratio: {req_miss_ratio:.4f}, Byte miss ratio: {byte_miss_ratio:.4f}") -# Step 3.1: Further process the first 1000 requests again +# Step 3.1: Process the first 1000 requests cache = lcs.S3FIFO( cache_size=1024 * 1024, # Cache specific parameters diff --git a/docs/src/en/getting_started/quickstart.md b/docs/src/en/getting_started/quickstart.md index 4246046..3e7771a 100644 --- a/docs/src/en/getting_started/quickstart.md +++ b/docs/src/en/getting_started/quickstart.md @@ -77,7 +77,7 @@ With libcachesim installed, you can start cache simulation for some eviction alg req_miss_ratio, byte_miss_ratio = cache.process_trace(reader) print(f"Request miss ratio: {req_miss_ratio:.4f}, Byte miss ratio: {byte_miss_ratio:.4f}") - # Step 3.1: Further process the first 1000 requests again + # Step 3.1: Process the first 1000 requests cache = lcs.S3FIFO( cache_size=1024 * 1024, # Cache specific parameters diff --git a/examples/basic_usage.py b/examples/basic_usage.py index d1bf0b1..9852f38 100644 --- a/examples/basic_usage.py +++ b/examples/basic_usage.py @@ -21,6 +21,13 @@ req_miss_ratio, byte_miss_ratio = cache.process_trace(reader) print(f"Request miss ratio: {req_miss_ratio:.4f}, Byte miss ratio: {byte_miss_ratio:.4f}") -# Step 3.1: Further process the first 1000 requests again +# Step 3.1: Process the first 1000 requests +cache = lcs.S3FIFO( + cache_size=1024 * 1024, + # Cache specific parameters + small_size_ratio=0.2, + ghost_size_ratio=0.8, + move_to_main_threshold=2, +) req_miss_ratio, byte_miss_ratio = cache.process_trace(reader, start_req=0, max_req=1000) -print(f"Request miss ratio: {req_miss_ratio:.4f}, Byte miss ratio: {byte_miss_ratio:.4f}") +print(f"Request miss ratio: {req_miss_ratio:.4f}, Byte miss ratio: {byte_miss_ratio:.4f}") \ No newline at end of file