From f707da2ec0e1572239d98eae0baf860b571a1aaa Mon Sep 17 00:00:00 2001 From: Harshad Hegde Date: Tue, 13 Feb 2024 01:11:28 -0600 Subject: [PATCH] Updated docs --- README.md | 8 ++++++-- docs/description.rst | 9 +++++---- 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index dcc5dbd..1d036cb 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,10 @@ codergpt [OPTIONS] COMMAND [ARGS]... - `-v, --verbose INTEGER`: Adjust the verbosity level (0 for default, 1 for verbose, 2 for debug). - `-q, --quiet`: Suppress output. - `--version`: Show the version number and exit. +- `--model`: Model to use for performing requests. + - Available models: + - OpenAI: [`gpt-3.5-turbo`, `gpt-4`, `gpt-4-turbo-preview`(default)] + - Google: [`gemini-pro`] #### Commands @@ -49,13 +53,13 @@ codergpt [OPTIONS] COMMAND [ARGS]... Analyze a package and display its file-language mapping. ```shell -codergpt inspect +codergpt --model inspect ``` ###### Example ```shell -$ codergpt inspect src/codergpt/ +$ codergpt --model gpt-4 inspect src/codergpt/ ``` ##### Explain diff --git a/docs/description.rst b/docs/description.rst index 452795f..ec86da2 100644 --- a/docs/description.rst +++ b/docs/description.rst @@ -16,7 +16,7 @@ Model Providers Implemented The following model providers have been implemented in CoderGPT: .. list-table:: - :widths: 25 75 + :widths: 75 25 :header-rows: 1 * - Provider @@ -38,7 +38,7 @@ The following model providers have been implemented in CoderGPT: export OPENAI_API_KEY='your-api-key-here' export GOOGLE_API_KEY='your-api-key-here' - Replace ``your-api-key-here`` with your actual OpenAI and Google API keys. This step is crucial for the proper functioning of CoderGPT as it relies on OpenAI and Google APIs for generating and modifying code. +Replace ``your-api-key-here`` with your actual OpenAI and Google API keys. This step is crucial for the proper functioning of CoderGPT as it relies on OpenAI and Google APIs for generating and modifying code. Installation ------------ @@ -78,6 +78,7 @@ Options - ``-v, --verbose INTEGER``: Set verbosity level (0, 1, or 2). - ``-q, --quiet``: Enable quiet mode. - ``--version``: Display version information. +- ``--model [gpt-3.5-turbo | gpt-4 | gpt-4-turbo (default) | gemini-pro]``: Set the model provider to use. Commands ~~~~~~~~ @@ -87,13 +88,13 @@ Commands .. code-block:: shell - codergpt inspect + codergpt --model inspect **Example** .. code-block:: shell - $ codergpt inspect src/codergpt/ + $ codergpt --model gpt-4 inspect src/codergpt/ Inspecting the code. File Language ------------------------------------------ ----------