change to vizro_ai

vizro-ai/docs/pages/explanation/disclaimer.md

@@ -1,6 +1,6 @@
 # Disclaimer
 
-Users must select one of the [supported Large Language Models (LLMs)](../user_guides/model_config.md) in order to use the `vizro-ai` package,
+Users must select one of the [supported Large Language Models (LLMs)](../user_guides/model_config.md) in order to use the `vizro_ai` package,
 and are responsible for obtaining their own suitable API key for the relevant model.
 
 ## Third Party API

vizro-ai/docs/pages/explanation/safety_in_vizro_ai.md

@@ -4,7 +4,7 @@ Generative AI models, especially Large Language Models (LLMs) represent signific
 Vizro-AI also leverages LLMs, however, as with any powerful tool, there are potential risks associated.
 
 Users must connect to a generative AI model, specifically LLMs to use Vizro-AI.
-We recommend users research and understand the selected model before using `vizro-ai` package.
+We recommend users research and understand the selected model before using `vizro_ai` package.
 
 Users are encouraged to treat AI-generated content as supplementary, **always apply human judgment**,
 approach with caution, review the relevant [disclaimer](disclaimer.md) page, and consider the following:
@@ -13,7 +13,7 @@ approach with caution, review the relevant [disclaimer](disclaimer.md) page, and
 
 Generative models can potentially generate information while appearing factual, being entirely fictitious or misleading.
 The vendor models might lack real-time knowledge or events beyond its last updates.
-`vizro-ai` output may vary and please always verify critical information.
+`vizro_ai` output may vary and please always verify critical information.
 It is the user's responsibility to discern the accuracy, consistent, and reliability of the generated content.
 
 ### 2. Unintended and Sensitive output
@@ -41,17 +41,17 @@ It's crucial for users to remain informed, cautious, and ethical in their applic
 
 ## Dependencies, Code Scanners and Infosec
 
-It may occur that dependencies of `vizro-ai` get flagged by code scanners and other infosec tools. As a consequence it may happen that
-`vizro-ai` also get flagged.
+It may occur that dependencies of `vizro_ai` get flagged by code scanners and other infosec tools. As a consequence it may happen that
+`vizro_ai` also get flagged.
 
 While we aim to resolve any flagged issues as soon as possible, there may not always be an immediate available fix, especially in a very dynamic environment such as generative AI. We encourage users to investigate if any flagged infosec issues are actually related
-to any functionality used in our code base or if they only concern functionality outside the scope of `vizro-ai`.
+to any functionality used in our code base or if they only concern functionality outside the scope of `vizro_ai`.
 
-In case those issues are related to code execution, note that `vizro-ai` has its own process of executing dynamic code (see [Safeguard Execution of Dynamic Code](safeguard.md)), and does not rely on its dependencies to do so.
+In case those issues are related to code execution, note that `vizro_ai` has its own process of executing dynamic code (see [Safeguard Execution of Dynamic Code](safeguard.md)), and does not rely on its dependencies to do so.
 
 ## Execution of Dynamic Code in Vizro-AI
 
-The `exec()` statement is used in `vizro-ai`. It allows for dynamic execution of Python programs which can be powerful, but can also pose security risk
+The `exec()` statement is used in `vizro_ai`. It allows for dynamic execution of Python programs which can be powerful, but can also pose security risk
 if used without caution. When paired with outputs from generative models, there is potential for unintended or malicious code execution.
 
 Users must exercise caution when executing code generated by or influenced by AI models. It's essential to:
@@ -60,6 +60,6 @@ Users must exercise caution when executing code generated by or influenced by AI
 - Always consider using controlled environments, such as virtual machines or containers, to execute uncertain code
 - Always be aware of potential risks when executing dynamically generated code in environments with access to sensitive data or systems
 - Always be aware that malicious code execution cannot be mitigated with 100% certainty
-- Always review and understand the selected model before connecting with `vizro-ai`
+- Always review and understand the selected model before connecting with `vizro_ai`
 
 If you would like to learn more about our efforts in safeguarding code execution, please refer to [Safeguard Execution of Dynamic Code](safeguard.md) for more information.

vizro-ai/docs/pages/tutorials/explore_vizro_ai.md

@@ -4,7 +4,7 @@ This tutorial serves as an exploration of the extended applications offered by V
 By the end of this tutorial, you will have gained an understanding of different language options and leveraging Vizro-AI to enhance the formatting your visualizations.
 
 ## Let's get started!
-### 1. Install vizro-ai and get ready to run your code
+### 1. Install Vizro-AI and get ready to run your code
 Before proceeding, ensure the installation of the `vizro_ai` package by following the steps outlined in the [installation guide](../user_guides/install.md). Once installed, you can execute your code either by pasting it into a Jupyter notebook cell or running it from a Python script.
 
 

vizro-ai/docs/pages/tutorials/quickstart.md

@@ -3,7 +3,7 @@ This tutorial serves as an introduction to Vizro-AI.
 It is a step-by-step guide to help you experiment and create your initial Vizro chart using Vizro-AI, our English-to-visualization package. The goal is to provide you with the necessary knowledge to explore further into our documentation.
 
 ## Let's get started!
-### 1. Install vizro-ai and its dependencies
+### 1. Install Vizro-AI and its dependencies
 If you haven't already installed `vizro_ai` package, follow the [installation guide](../user_guides/install.md)
 to do so inside a virtual environment.
 
@@ -28,7 +28,7 @@ This opens a browser tab, and you can navigate to your preferred folder for this
 ??? tip "Beginners/Code novices"
     If you followed the beginners steps in the [installation guide](../user_guides/install.md), you should already be set, and you can continue below.
 
-Confirm that vizro-ai is installed by typing the following into a jupyter cell in your notebook and running it.
+Confirm that `vizro_ai` is installed by typing the following into a jupyter cell in your notebook and running it.
 
 ```py
 import vizro_ai
@@ -48,7 +48,7 @@ from dotenv import load_dotenv
 load_dotenv()
 ```
 
-### 4. Ask your first question using vizro-ai
+### 4. Ask your first question using Vizro-AI
 
 For your first visualization, we will create a chart illustrating the GDP of various continents while including a reference line for the average.
 

vizro-ai/docs/pages/user_guides/install.md

@@ -40,7 +40,7 @@ pip install jupyter
 ??? tip "Beginners/Code novices"
     If you're new to coding or consider yourself a beginner, you can follow these following steps to avoid using the terminal:
 
-    - Search `vizro-ai` and install it using the Anaconda Navigator package manager. You can find instructions [here](https://docs.anaconda.com/free/navigator/tutorials/manage-packages/)
+    - Search `vizro_ai` and install it using the Anaconda Navigator package manager. You can find instructions [here](https://docs.anaconda.com/free/navigator/tutorials/manage-packages/)
     - Similarly, search `jupyter` and install it through the same procedure
     - Once installed, launching a Jupyter notebook becomes straightforward; you can find guidance [here](https://problemsolvingwithpython.com/02-Jupyter-Notebooks/02.04-Opening-a-Jupyter-Notebook/#open-a-jupyter-notebook-with-anaconda-navigator)
     - With Jupyter, you can easily copy and paste any of the provided examples into a notebook cell, evaluate the cell, and examine the results

vizro-ai/docs/pages/user_guides/model_config.md

@@ -2,7 +2,7 @@
 
 !!! Warning
 
-    Users are recommended to exercise caution and to research and understand the selected Large Language Model (LLM) before using `vizro-ai`.
+    Users are recommended to exercise caution and to research and understand the selected Large Language Model (LLM) before using `vizro_ai`.
     Users should be cautious about sharing or inputting any personal or sensitive information.
 
     **Data is sent to model vendors if you connect to LLMs via their APIs.**