Fixed up missing dependencies and updated README.md #232
Conversation
WalkthroughThe project has been updated to enhance its command-line interface, adding new commands for managing fine-tuning jobs, files, and usage with OpenAI's GPT3.5 models. The documentation now previews these CLI features, and dependencies have been updated to include Changes
Assessment against linked issues
Poem
TipsChat with CodeRabbit Bot (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 4
Configuration used: CodeRabbit UI
Files ignored due to filter (1)
- pyproject.toml
Files selected for processing (5)
- README.md (1 hunks)
- docs/cli/finetune.md (2 hunks)
- docs/index.md (1 hunks)
- requirements-doc.txt (1 hunks)
- requirements.txt (1 hunks)
Files skipped from review due to trivial changes (3)
- README.md
- docs/index.md
- requirements-doc.txt
Additional comments: 1
docs/cli/finetune.md (1)
- 9-13: Please verify that the removal of the section inviting contributions for specific tasks (like "Adding filenames on upload") is intentional and aligns with the current project goals.
| aiohttp |
There was a problem hiding this comment.
Consider pinning the versions of the newly added dependencies rich and aiohttp to ensure consistent builds and avoid potential incompatibilities with future versions.
| │ --validation-file TEXT Path to the validation file [default: None] │ | ||
| │ --model-suffix TEXT Suffix to identify the model [default: None] │ | ||
| │ --help Show this message and exit. │ | ||
| ╰──────────────────────────────────────────────────────────────────────────────── | ||
| ``` | ||
|
|
||
| #### Usage |
There was a problem hiding this comment.
The example usage command should be updated to include the --model-suffix option to demonstrate its usage, ensuring consistency with the documentation.
The --validation_file option in the example usage command should use a hyphen (--validation-file) to match the option format in the help message.
- --validation_file validation_data.jsonl
+ --validation-file validation_data.jsonlCommittable suggestion
❗ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| #### Usage | |
| ``#### Usage | |
| `` | |
| </details> | |
| <!-- suggestion_end --> | |
| <!-- This is an auto-generated comment by CodeRabbit --> | |
| --- | |
| The `create_from_id` command in the example usage should use hyphens (`create-from-id`) to match the actual command format. | |
| ```diff | |
| - $ instructor jobs create_from_id <file_id> --validation_file <validation_file_id> --n_epochs 3 --batch_size 16 --learning_rate_multiplier 0.5 | |
| + $ instructor jobs create-from-id <file_id> --validation-file <validation_file_id> --n-epochs 3 --batch-size 16 --learning-rate-multiplier 0.5 |
Committable suggestion
❗ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| #### Usage | |
| $ instructor jobs create-from-id <file_id> --validation-file <validation_file_id> --n-epochs 3 --batch-size 16 --learning-rate-multiplier 0.5 |
This fixes #184 and #231
Summary by CodeRabbit
New Features
instructor jobs).instructor files).instructor usage).Documentation
--model-suffixoption and changes to--validation-filedefault value.Refactor
Chores
aiohttpandyarllibraries to newer versions for enhanced stability and performance.richandaiohttpto the project's dependencies.