Repository navigation
Fix and simplify README usage instructions - #86
Merged
Merged
Conversation
This file contains hidden or 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
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.
Summary
The usage instructions in the README and the Docker guide did not match how
bin/aipworks ondevelopment.--start-date. Since--end-datedefaults to today, this ran every day from that date until today. The examples now pass both dates, and the default is explained.--end-dateand date ranges were not documented._example.csvfiles and also to copy them first. It now says to copy and then edit the copies, and which file is required.-d. The example command now uses-d.The setup and usage sections were also rewritten to be shorter and clearer, with the common commands in one table.
Testing
Checked that every command and option in the docs exists in
bin/aip --help,bin/aip run-models --helpandbin/aip rebuild-kb --help.