From 518c1098fdae6bba8329c6c430b951b3f60201e0 Mon Sep 17 00:00:00 2001 From: Adam Belfki Date: Fri, 13 Sep 2024 14:01:11 -0400 Subject: [PATCH] doc: scan defaults to False --- src/nnsight/contexts/Invoker.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/nnsight/contexts/Invoker.py b/src/nnsight/contexts/Invoker.py index 3c436b6f..c60b94fd 100755 --- a/src/nnsight/contexts/Invoker.py +++ b/src/nnsight/contexts/Invoker.py @@ -29,7 +29,7 @@ class Invoker(AbstractContextManager): scan (bool): If to execute the model using `FakeTensor` in order to update the potential sizes/dtypes of all modules' Envoys' inputs/outputs as well as validate things work correctly. Scanning is not free computation wise so you may want to turn this to false when running in a loop. When making interventions, you made get shape errors if scan is false as it validates operations based on shapes so - for looped calls where shapes are consistent, you may want to have scan=True for the first loop. Defaults to True. + for looped calls where shapes are consistent, you may want to have scan=True for the first loop. Defaults to False. kwargs (Dict[str,Any]): Keyword arguments passed to the model's _prepare_inputs method. scanning (bool): If currently scanning. """