You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/configuration.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,7 @@ tests-root = "tests"
16
16
test-framework = "pytest"
17
17
formatter-cmds = ["black $file"]
18
18
# optional configuration
19
+
benchmarks-root = "tests/benchmarks"# Required when running with --benchmark
19
20
ignore-paths = ["my_module/build/"]
20
21
pytest-cmd = "pytest"
21
22
disable-imports-sorting = false
@@ -29,6 +30,7 @@ Required Options:
29
30
-`test-framework`: The test framework you use for your project. Codeflash supports `pytest` and `unittest`.
30
31
31
32
Optional Configuration:
33
+
-`benchmarks-root`: The directory where your benchmarks are located. Codeflash will use this directory to discover existing benchmarks. Note that this option is required when running with `--benchmark`.
32
34
-`ignore-paths`: A list of paths withing the `module-root` to ignore when optimizing code. Codeflash will not optimize code in these paths. Useful for ignoring build directories or other generated code. You can also leave this empty if not needed.
33
35
-`pytest-cmd`: The command to run your tests. Defaults to `pytest`. You can specify extra commandline arguments here for pytest.
34
36
-`formatter-cmds`: The command line to run your code formatter or linter. Defaults to `["black $file"]`. In the command line `$file` refers to the current file being optimized. The assumption with using tools here is that they overwrite the same file and returns a zero exit code. You can also specify multiple tools here that run in a chain as a toml array. You can also disable code formatting by setting this to `["disabled"]`.
0 commit comments