Performance testing #990
Open
Performance testing #990
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gerrycampion
requested changes
Jan 31, 2025
tests/PerformanceTest.py
Outdated
There was a problem hiding this comment.
Can you add the new cli instructions to the readme
gerrycampion
requested changes
Feb 3, 2025
README.md
Outdated
| To execute the performance test, navigate to the root directory of the project and run the following command: | ||
|
|
||
| ```sh | ||
| python tests/PerformanceTest.py -dd <DATASET_DIRECTORY> -rd <RULES_DIRECTORY> -total_calls <NUMBER_OF_CALLS> -od <OUTPUT_DIRECTORY> |
There was a problem hiding this comment.
If this is the same as the -d, --data TEXT and -lr, --local_rules TEXT args in the validate command, it would be good to use the same arg names.
README.md
Outdated
|
|
||
| This repository includes a performance testing script located in the `tests` folder under the filename `PerformanceTest.py`. The script is designed to evaluate the execution time of rules against datasets by running multiple test iterations. | ||
|
|
||
| ### Running the Performance Test |
There was a problem hiding this comment.
This and the next header should be nested under the Performance Testing header. IOW, use 4 #
README.md
Outdated
| ``` | ||
| ### Performance Test Command-Line Flags | ||
|
|
||
| - **`-dd` (Dataset Directory)**: The directory containing the dataset files in `.json` or `.xpt` format. |
There was a problem hiding this comment.
Format the documentation similar to the existing documentation. For example, use a code block for the args
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The pull request adds performance Test to the tests folder. The performance test can be run by following command
python tests/PerformanceTest.py -dd path/to/folder/with/datasets -rd path/to/folder/with/rule/files -total_calls 1Total calls define how many times do you want to execute a rule. The report will be saved in the directory from whic the test file was executed