From dd375f798bea59b964e38847aadcb3617f866ee0 Mon Sep 17 00:00:00 2001 From: Jo Stichbury Date: Tue, 20 Feb 2024 11:51:35 +0000 Subject: [PATCH] Fix broken links Signed-off-by: Jo Stichbury --- vizro-ai/docs/index.md | 4 ++-- vizro-ai/docs/pages/explanation/disclaimer.md | 2 +- vizro-ai/docs/pages/tutorials/explore-vizro-ai.md | 8 ++++---- vizro-ai/docs/pages/tutorials/quickstart.md | 10 +++++----- vizro-ai/docs/pages/user-guides/install.md | 2 +- vizro-ai/docs/pages/user-guides/run-vizro-ai.md | 4 ++-- 6 files changed, 15 insertions(+), 15 deletions(-) diff --git a/vizro-ai/docs/index.md b/vizro-ai/docs/index.md index 31f61a372..33fed5078 100644 --- a/vizro-ai/docs/index.md +++ b/vizro-ai/docs/index.md @@ -18,7 +18,7 @@ Vizro-AI leverages the power of [Plotly](https://plotly.com/python/) to produce before using the `vizro-ai` package. Since users must connect to Large Language Models (LLMs) in order to use Vizro-AI, - please also ensure that you review our guides on the [usage of LLMs](pages/explanation/safety_in_vizro_ai.md) + please also ensure that you review our guides on the [usage of LLMs](pages/explanation/safety-in-vizro-ai.md) and the required [safeguarding for dynamic code evaluation](pages/explanation/safeguard.md). @@ -36,7 +36,7 @@ Vizro-AI leverages the power of [Plotly](https://plotly.com/python/) to produce - +
User Guides
diff --git a/vizro-ai/docs/pages/explanation/disclaimer.md b/vizro-ai/docs/pages/explanation/disclaimer.md index 71473d98a..27b233f7e 100644 --- a/vizro-ai/docs/pages/explanation/disclaimer.md +++ b/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 diff --git a/vizro-ai/docs/pages/tutorials/explore-vizro-ai.md b/vizro-ai/docs/pages/tutorials/explore-vizro-ai.md index 96b2d0af1..5ae025d5a 100644 --- a/vizro-ai/docs/pages/tutorials/explore-vizro-ai.md +++ b/vizro-ai/docs/pages/tutorials/explore-vizro-ai.md @@ -5,19 +5,19 @@ By the end of this tutorial, you will have gained an understanding of different ## Let's get started! ### 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. +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. ??? tip "Beginners/Code novices" - For those new to Python or virtual environments, a user-friendly alternative is available in the [installation guide](../user_guides/install.md), offering a graphical user interface without the need for terminal commands. + For those new to Python or virtual environments, a user-friendly alternative is available in the [installation guide](../user-guides/install.md), offering a graphical user interface without the need for terminal commands. -A prerequisite for this tutorial is access to one of the supported large language models. Please refer to the [api setup](../user_guides/api_setup.md) for instructions on setting up the API. +A prerequisite for this tutorial is access to one of the supported large language models. Please refer to the [api setup](../user-guides/api-setup.md) for instructions on setting up the API. Upon successful setup, your API key should be ready in the environment when you import `vizro_ai`. If you would like to customize the `.env` file location and name, you can set it manually. You can override the default import of the `.env` file by specifying the path and name of your custom `.env` file. -Please refer to [API setup](../user_guides/api_setup.md) for instructions on customizing the `.env` file location and name. +Please refer to [API setup](../user-guides/api-setup.md) for instructions on customizing the `.env` file location and name. ### 2. Create your visualization using different languages diff --git a/vizro-ai/docs/pages/tutorials/quickstart.md b/vizro-ai/docs/pages/tutorials/quickstart.md index dcfad4b8d..d35e3800e 100644 --- a/vizro-ai/docs/pages/tutorials/quickstart.md +++ b/vizro-ai/docs/pages/tutorials/quickstart.md @@ -4,11 +4,11 @@ It is a step-by-step guide to help you experiment and create your initial Vizro ## Let's get started! ### 1. Install Vizro-AI and its dependencies -If you haven't already installed `vizro_ai` package, follow the [installation guide](../user_guides/install.md) +If you haven't already installed `vizro_ai` package, follow the [installation guide](../user-guides/install.md) to do so inside a virtual environment. ??? tip "Beginners/Code novices" - If you consider yourself a beginner to python and/or virtual environments, there is also a section in the [installation guide](../user_guides/install.md) that avoids any use of terminals and relies only upon a graphical user interface. + If you consider yourself a beginner to python and/or virtual environments, there is also a section in the [installation guide](../user-guides/install.md) that avoids any use of terminals and relies only upon a graphical user interface. ### 2. Set up jupyter notebook A good way to initially explore Vizro-AI is from a Jupyter notebook. @@ -26,7 +26,7 @@ jupyter notebook This opens a browser tab, and you can navigate to your preferred folder for this new project. Create a new notebook Python 3 (ipykernel) notebook from the "New" dropdown. Make sure that you select your environment as kernel. ??? 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. + 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. @@ -39,7 +39,7 @@ You should see a return output of the version. ### 3. Large Language Model (LLM) API KEY -A prerequisite to use Vizro-AI is access to one of the supported LLMs. Refer to the [user guide](../user_guides/api_setup.md) on how to set up the API. +A prerequisite to use Vizro-AI is access to one of the supported LLMs. Refer to the [user guide](../user-guides/api-setup.md) on how to set up the API. ### 4. Ask your first question using Vizro-AI @@ -87,4 +87,4 @@ Let's create another example and read through the additional information. Now, you have created your first charts with Vizro-AI and are ready to explore the documentation further. -A good place to start would be to go through the [model configuration](../user_guides/model_config.md) or different [run options](../user_guides/run_vizro_ai.md) including application integration. +A good place to start would be to go through the [model configuration](../user-guides/model-config.md) or different [run options](../user-guides/run-vizro-ai.md) including application integration. diff --git a/vizro-ai/docs/pages/user-guides/install.md b/vizro-ai/docs/pages/user-guides/install.md index 2dfd246f3..cb53dcecc 100644 --- a/vizro-ai/docs/pages/user-guides/install.md +++ b/vizro-ai/docs/pages/user-guides/install.md @@ -15,7 +15,7 @@ export OPENAI_API_KEY="..." ``` -More details can be found in the [environment setup guide](../user_guides/api_setup.md). +More details can be found in the [environment setup guide](../user-guides/api-setup.md). ??? tip "Beginners/Code novices" If you are a beginner or new to coding and wish to avoid using the terminal, you can follow these steps: diff --git a/vizro-ai/docs/pages/user-guides/run-vizro-ai.md b/vizro-ai/docs/pages/user-guides/run-vizro-ai.md index 976bded98..d43dfa7fa 100644 --- a/vizro-ai/docs/pages/user-guides/run-vizro-ai.md +++ b/vizro-ai/docs/pages/user-guides/run-vizro-ai.md @@ -6,7 +6,7 @@ This guide offers insights into different options of running Vizro-AI, including To run Vizro-AI in jupyter, create a new cell and execute the code below to render the described visualization. You should see the chart as an output. ??? note "Note: API key" - Make sure you have followed the [environment setup guide](../user_guides/api_setup.md) and + Make sure you have followed the [environment setup guide](../user-guides/api-setup.md) and your api key is set up in a `.env` file in the same folder as your `ipynb` file. !!! example "Bar chart" @@ -31,7 +31,7 @@ Please note that the chart's appearance may not precisely resemble the one displ You can utilize Vizro-AI in any standard development environment by creating a `.py` file and executing the following code. As a result, the rendered chart will display in a browser window. ??? note "Note: API key" - Make sure you have followed [environment setup guide](../user_guides/api_setup.md) and + Make sure you have followed [environment setup guide](../user-guides/api-setup.md) and your API key is set up in the environment where your `.py` script is running with command as below: ``` export OPENAI_API_KEY="your api key"