Merge pull request #55 from A-Baji/dev

3.0.9

Author: A-Baji

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) convention.
 
+## [3.0.9] - 07-11-2024
+
+### Changed
+
+- consistently capitalize Discord and OpenAI across the project
+
 ## [3.0.8] - 07-11-2024
 
 ### Changed
@@ -102,7 +108,7 @@ Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and
 ### Changed
 
 - flag to use an existing dataset for model creation to allow manual revision
-- user input for model creation updated to work with new discord naming system
+- user input for model creation updated to work with new Discord naming system
 - tweaked readme
 
 ## [1.2.2] - 02-22-2023
@@ -128,18 +134,19 @@ Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and
 
 ### Changed
 
-- replaced `subprocess` instances with appropriate openAI python API methods
+- replaced `subprocess` instances with appropriate OpenAI python API methods
 
 ### Removed
 
-- dataset clean up step with openAI fine tune API
+- dataset clean up step with OpenAI fine tune API
 
 ## [1.0.1] - 02-11-2023
 
 ### Changed
 
 - switched to `pathlib` for file path parsing
 
+[3.0.9]: https://github.com/A-Baji/discordAI-modelizer/compare/3.0.8...3.0.9
 [3.0.8]: https://github.com/A-Baji/discordAI-modelizer/compare/3.0.7...3.0.8
 [3.0.7]: https://github.com/A-Baji/discordAI-modelizer/compare/3.0.6...3.0.7
 [3.0.6]: https://github.com/A-Baji/discordAI-modelizer/compare/3.0.5...3.0.6

README.md

@@ -1,5 +1,5 @@
 # DiscordAI Modelizer
-DiscordAI Modelizer is a python package that can generate custom openai models based on a discord user's chat history in a discord channel. It uses [DiscordChatExporter](https://github.com/Tyrrrz/DiscordChatExporter) to download the logs of a channel, processes the logs into a usable dataset, and then uses [openAI's API](https://beta.openai.com/docs/introduction) to create a customized model. It also wraps some of the tools from the openAI API to help with managing customizations.
+DiscordAI Modelizer is a python package that can generate custom openai models based on a Discord user's chat history in a Discord channel. It uses [DiscordChatExporter](https://github.com/Tyrrrz/DiscordChatExporter) to download the logs of a channel, processes the logs into a usable dataset, and then uses [OpenAI's API](https://beta.openai.com/docs/introduction) to create a customized model. It also wraps some of the tools from the OpenAI API to help with managing customizations.
 
 DiscordAI Modelizer is primarily used as a subcomponent of [DiscordAI](https://github.com/A-Baji/discordAI), but may also be used independently.
 
@@ -12,24 +12,24 @@ DiscordAI Modelizer is primarily used as a subcomponent of [DiscordAI](https://g
 
 ## Commands
 ### Model
-Commands related to your openAI models
+Commands related to your OpenAI models
 #### `discordai_modelizer model list`
-* List your openAI models
+* List your OpenAI models
 #### `discordai_modelizer model create`
-* Create a new openAI customized model by downloading the specified chat logs, parsing them into a usable dataset, and then training a customized model using openai
+* Create a new OpenAI customized model by downloading the specified chat logs, parsing them into a usable dataset, and then training a customized model using openai
 * For proper usage, see the [DiscordAI guide](https://github.com/A-Baji/discordAI#create-a-new-customized-openai-model)
 #### `discordai_modelizer model delete`
-* Delete an openAI model
+* Delete an OpenAI model
 ### Job
-Commands related to your openAI jobs
+Commands related to your OpenAI jobs
 #### `discordai_modelizer job list`
-* List your openAI customization jobs
+* List your OpenAI customization jobs
 #### `discordai_modelizer job info`
-* Get an openAI customization job's info
+* Get an OpenAI customization job's info
 #### `discordai_modelizer job event`
-* Get an openAI customization job's events
+* Get an OpenAI customization job's events
 #### `discordai_modelizer job cancel`
-* Cancel an openAI customization job
+* Cancel an OpenAI customization job
 
 ## Disclaimer
 This application allows users to download the chat history of any channel for which they have permission to invite a bot, and then use those logs to create an openai model based on a user's chat messages. It is important to note that this application should only be used with the consent of all members of the channel. Using this application for malicious purposes, such as impersonation, or without the consent of all members is strictly prohibited.

discordai_modelizer/command_line/subparsers.py

@@ -8,7 +8,7 @@ def set_bot_key_help_str(is_parent=False):
 
 def setup_model_list(model_subcommand, is_parent=False):
     model_list = model_subcommand.add_parser(
-        "list", help="List your openAi customized models"
+        "list", help="List your OpenAI customized models"
     )
     model_list_required_named = model_list.add_argument_group(
         "required named arguments"
@@ -22,7 +22,7 @@ def setup_model_list(model_subcommand, is_parent=False):
         "--openai-key",
         type=str,
         dest="openai_key",
-        help=f"The openAI API key to list the models for. Must either be passed in as an argument or set {set_openai_help_str(is_parent)}",
+        help=f"The OpenAI API key to list the models for. Must either be passed in as an argument or set {set_openai_help_str(is_parent)}",
     )
     model_list_optional_named.add_argument(
         "--full",
@@ -36,7 +36,7 @@ def setup_model_list(model_subcommand, is_parent=False):
 def setup_model_create(model_subcommand, is_parent=False):
     model_create = model_subcommand.add_parser(
         "create",
-        help="Create a new openAI customized model by downloading the specified chat logs, parsing them into a usable dataset, and then training a customized model using openai",
+        help="Create a new OpenAI customized model by downloading the specified chat logs, parsing them into a usable dataset, and then training a customized model using openai",
     )
     model_create_required_named = model_create.add_argument_group(
         "required named arguments"
@@ -50,30 +50,30 @@ def setup_model_create(model_subcommand, is_parent=False):
         "--discord-token",
         type=str,
         dest="discord_token",
-        help=f"The discord token for your bot. Must either be passed in as an argument or set {set_bot_key_help_str(is_parent)}",
+        help=f"The Discord token for your bot. Must either be passed in as an argument or set {set_bot_key_help_str(is_parent)}",
     )
     model_create_required_named.add_argument(
         "-o",
         "--openai-key",
         type=str,
         dest="openai_key",
-        help=f"The openAI API key to use to create the model. Must either be passed in as an argument or set {set_openai_help_str(is_parent)}",
+        help=f"The OpenAI API key to use to create the model. Must either be passed in as an argument or set {set_openai_help_str(is_parent)}",
     )
     model_create_required_named.add_argument(
         "-c",
         "--channel",
         required=True,
         type=str,
         dest="channel",
-        help="The ID of the discord channel you want to use",
+        help="The ID of the Discord channel you want to use",
     )
     model_create_required_named.add_argument(
         "-u",
         "--user",
         required=True,
         type=str,
         dest="user",
-        help="The unique username of the discord user you want to use",
+        help="The unique username of the Discord user you want to use",
     )
 
     model_create_optional_named.add_argument(
@@ -156,7 +156,7 @@ def setup_model_create(model_subcommand, is_parent=False):
         action="store_true",
         required=False,
         dest="redownload",
-        help="Redownload the discord chat logs",
+        help="Redownload the Discord chat logs",
     )
     model_create_optional_named.add_argument(
         "--use_existing",
@@ -170,7 +170,7 @@ def setup_model_create(model_subcommand, is_parent=False):
 def setup_model_delete(model_subcommand, is_parent=False):
     model_delete = model_subcommand.add_parser(
         "delete",
-        help="Delete an openAI customized model",
+        help="Delete an OpenAI customized model",
     )
     model_delete_required_named = model_delete.add_argument_group(
         "required named arguments"
@@ -184,7 +184,7 @@ def setup_model_delete(model_subcommand, is_parent=False):
         "--openai-key",
         type=str,
         dest="openai_key",
-        help=f"The openAI API key associated with the model to delete. Must either be passed in as an argument or set {set_openai_help_str(is_parent)}",
+        help=f"The OpenAI API key associated with the model to delete. Must either be passed in as an argument or set {set_openai_help_str(is_parent)}",
     )
     model_delete_required_named.add_argument(
         "-m",
@@ -206,7 +206,7 @@ def setup_model_delete(model_subcommand, is_parent=False):
 
 def setup_job_list(job_subcommand, is_parent=False):
     job_list = job_subcommand.add_parser(
-        "list", help="List your openAI customization jobs"
+        "list", help="List your OpenAI customization jobs"
     )
     job_list_required_named = job_list.add_argument_group("required named arguments")
     job_list_optional_named = job_list.add_argument_group("optional named arguments")
@@ -216,7 +216,7 @@ def setup_job_list(job_subcommand, is_parent=False):
         "--openai-key",
         type=str,
         dest="openai_key",
-        help=f"The openAI API key to list the jobs for. Must either be passed in as an argument or set {set_openai_help_str(is_parent)}",
+        help=f"The OpenAI API key to list the jobs for. Must either be passed in as an argument or set {set_openai_help_str(is_parent)}",
     )
     job_list_optional_named.add_argument(
         "--full",
@@ -229,7 +229,7 @@ def setup_job_list(job_subcommand, is_parent=False):
 
 def setup_job_info(job_subcommand, is_parent=False):
     job_info = job_subcommand.add_parser(
-        "info", help="Get an openAI customization job's info"
+        "info", help="Get an OpenAI customization job's info"
     )
     job_info_required_named = job_info.add_argument_group("required named arguments")
 
@@ -238,7 +238,7 @@ def setup_job_info(job_subcommand, is_parent=False):
         "--openai-key",
         type=str,
         dest="openai_key",
-        help=f"The openAI API key associated with the job to see the info for. Must either be passed in as an argument or set {set_openai_help_str(is_parent)}",
+        help=f"The OpenAI API key associated with the job to see the info for. Must either be passed in as an argument or set {set_openai_help_str(is_parent)}",
     )
     job_info_required_named.add_argument(
         "-j",
@@ -252,7 +252,7 @@ def setup_job_info(job_subcommand, is_parent=False):
 
 def setup_job_events(job_subcommand, is_parent=False):
     job_events = job_subcommand.add_parser(
-        "events", help="Get an openAI customization job's events"
+        "events", help="Get an OpenAI customization job's events"
     )
     job_events_required_named = job_events.add_argument_group(
         "required named arguments"
@@ -263,7 +263,7 @@ def setup_job_events(job_subcommand, is_parent=False):
         "--openai-key",
         type=str,
         dest="openai_key",
-        help=f"The openAI API key associated with the job to see the events for. Must either be passed in as an argument or set {set_openai_help_str(is_parent)}",
+        help=f"The OpenAI API key associated with the job to see the events for. Must either be passed in as an argument or set {set_openai_help_str(is_parent)}",
     )
     job_events_required_named.add_argument(
         "-j",
@@ -277,7 +277,7 @@ def setup_job_events(job_subcommand, is_parent=False):
 
 def setup_job_cancel(job_subcommand, is_parent=False):
     job_cancel = job_subcommand.add_parser(
-        "cancel", help="Cancel an openAI customization job"
+        "cancel", help="Cancel an OpenAI customization job"
     )
     job_cancel_required_named = job_cancel.add_argument_group(
         "required named arguments"
@@ -288,7 +288,7 @@ def setup_job_cancel(job_subcommand, is_parent=False):
         "--openai-key",
         type=str,
         dest="openai_key",
-        help=f"The openAI API key associated with the job to cancel. Must either be passed in as an argument or set {set_openai_help_str(is_parent)}",
+        help=f"The OpenAI API key associated with the job to cancel. Must either be passed in as an argument or set {set_openai_help_str(is_parent)}",
     )
     job_cancel_required_named.add_argument(
         "-j",

discordai_modelizer/customize.py

@@ -86,7 +86,7 @@ def create_model(
     if use_existing:
         print("INFO: Using existing dataset... Skipping download and parsing.")
     else:
-        print("INFO: Parsing chat logs into an openAI compatible dataset...")
+        print("INFO: Parsing chat logs into an OpenAI compatible dataset...")
         try:
             parse_logs(
                 full_logs_path,
@@ -103,7 +103,7 @@ def create_model(
         if not clean:
             print(f"INFO: Dataset saved to {full_dataset_path}")
 
-    # Train customized openAI model
+    # Train customized OpenAI model
     if base_model in ["davinci", "babbage"]:
         print("INFO: Starting OpenAI fine-tune job...")
         upload_response = client.files.create(

discordai_modelizer/version.py

@@ -1 +1 @@
-__version__ = "3.0.8"
+__version__ = "3.0.9"

setup.py

@@ -21,7 +21,7 @@
     version=package.__version__,
     author="Adib Baji",
     author_email="[email protected]",
-    description="A package that utilizes openAI to create custom AI models out of your Discord chat history",
+    description="A package that utilizes OpenAI to create custom AI models out of your Discord chat history",
     long_description=pathlib.Path("README.md").read_text(),
     long_description_content_type="text/markdown",
     url="https://github.com/A-Baji/discordAI-modelizer",

tests/test_modelization.py

@@ -45,7 +45,7 @@ def test_use_existing_fail(capsys, default_file_output):
 def test_not_use_existing(capsys, default_file_output):
     customize.create_model(CHANNEL_ID, USER, use_existing=False)
     stdout = capsys.readouterr()
-    assert "INFO: Parsing chat logs into an openAI compatible dataset..." in stdout.out
+    assert "INFO: Parsing chat logs into an OpenAI compatible dataset..." in stdout.out
 
 
 def test_not_use_existing_dirty(capsys, default_file_output):