This pull request includes updates to the README and notebook files in the gen-ai/Assistants directory. The changes primarily involve the addition of more detailed documentation and explanations, as well as some code refactoring for better readability and maintainability.
gen-ai/Assistants/api-in-a-box/failed_banks/README.md, gen-ai/Assistants/api-in-a-box/math_tutor/README.md, gen-ai/Assistants/api-in-a-box/personal_finance/README.md: Updated the objective sections to clarify that the provided files are notebook files, not Python files. [1][2][3]
Code refactoring:
gen-ai/Assistants/api-in-a-box/failed_banks/assistant-failed_banks.ipynb, gen-ai/Assistants/api-in-a-box/math_tutor/assistant-math_tutor.ipynb, gen-ai/Assistants/api-in-a-box/personal_finance/assistant-personal_finance.ipynb: Refactored the code to install the required packages from a requirements file, load the environment variables from a .env file, and perform cleanup conditionally based on a should_cleanup variable. Also, added more detailed explanations and divided the notebooks into sections such as "Objective", "Time", "About this example", "Before you begin", and "Installation". [1][2][3]
This pull request includes updates to the README and notebook files in the
gen-ai/Assistantsdirectory. The changes primarily involve the addition of more detailed documentation and explanations, as well as some code refactoring for better readability and maintainability.Documentation updates:
gen-ai/Assistants/README.md: Added a new assistant to the list of samples.gen-ai/Assistants/api-in-a-box/README.md: Updated the descriptions of several assistants.gen-ai/Assistants/api-in-a-box/failed_banks/README.md,gen-ai/Assistants/api-in-a-box/math_tutor/README.md,gen-ai/Assistants/api-in-a-box/personal_finance/README.md: Updated the objective sections to clarify that the provided files are notebook files, not Python files. [1] [2] [3]Code refactoring:
gen-ai/Assistants/api-in-a-box/failed_banks/assistant-failed_banks.ipynb,gen-ai/Assistants/api-in-a-box/math_tutor/assistant-math_tutor.ipynb,gen-ai/Assistants/api-in-a-box/personal_finance/assistant-personal_finance.ipynb: Refactored the code to install the required packages from a requirements file, load the environment variables from a.envfile, and perform cleanup conditionally based on ashould_cleanupvariable. Also, added more detailed explanations and divided the notebooks into sections such as "Objective", "Time", "About this example", "Before you begin", and "Installation". [1] [2] [3]