diff --git a/vizro-ai/.readthedocs.yaml b/vizro-ai/.readthedocs.yaml new file mode 100644 index 000000000..dd8f1f4ac --- /dev/null +++ b/vizro-ai/.readthedocs.yaml @@ -0,0 +1,16 @@ +# Read the Docs configuration file for MkDocs projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.11" + commands: + - pip install hatch + - cd vizro-ai/ && hatch run docs:mkdocs build + - mkdir --parents $READTHEDOCS_OUTPUT + - mv vizro-ai/site/ $READTHEDOCS_OUTPUT/html diff --git a/vizro-ai/README.md b/vizro-ai/README.md index d9685f76c..374ffa851 100644 --- a/vizro-ai/README.md +++ b/vizro-ai/README.md @@ -4,8 +4,12 @@ Vizro-AI is a tool for generating visualizations. ## Disclaimer -Please review the [Disclaimer](docs/pages/explanation/disclaimer.md) before using `vizro-ai` package. +Please review the [Disclaimer](https://vizro-ai.readthedocs.io/en/latest/pages/explanation/disclaimer/) before using `vizro-ai` package. ## Documentation -Here is the link to the [Documentation](docs/pages). +For more information, please refer to our [Documentation](https://vizro-ai.readthedocs.io/en/latest/). + +## Acknowledgment + +Vizro-AI is powered by [LangChain](https://github.com/langchain-ai/langchain). diff --git a/vizro-ai/changelog.d/20231102_095201_maximilian_schulz_hosting_vizro_ai.md b/vizro-ai/changelog.d/20231102_095201_maximilian_schulz_hosting_vizro_ai.md new file mode 100644 index 000000000..f1f65e73c --- /dev/null +++ b/vizro-ai/changelog.d/20231102_095201_maximilian_schulz_hosting_vizro_ai.md @@ -0,0 +1,48 @@ + + + + + + + + + diff --git a/vizro-ai/docs/index.md b/vizro-ai/docs/index.md index abca88111..db302cbd1 100644 --- a/vizro-ai/docs/index.md +++ b/vizro-ai/docs/index.md @@ -6,8 +6,8 @@ Vizro-AI is a tool for generating data visualizations. 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 [usage of LLMs](pages/explanation/safety_in_vizro_ai.md) - and required [safeguarding for dynamic code evaluation](pages/explanation/safeguard.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).
diff --git a/vizro-ai/docs/pages/explanation/safety_in_vizro_ai.md b/vizro-ai/docs/pages/explanation/safety_in_vizro_ai.md index 744227180..4595d4692 100644 --- a/vizro-ai/docs/pages/explanation/safety_in_vizro_ai.md +++ b/vizro-ai/docs/pages/explanation/safety_in_vizro_ai.md @@ -39,6 +39,16 @@ These models can be exploited for various malicious activities. Users should be It's crucial for users to remain informed, cautious, and ethical in their applications. +## 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. + +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`. + +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 diff --git a/vizro-ai/docs/stylesheets/extra.css b/vizro-ai/docs/stylesheets/extra.css index 17e3b3ae4..5e48e8347 100644 --- a/vizro-ai/docs/stylesheets/extra.css +++ b/vizro-ai/docs/stylesheets/extra.css @@ -41,3 +41,7 @@ td:not([class]):not(:last-child) { border-right: 1px solid lightgrey; } + +.md-source__fact--version { + display: none; +} diff --git a/vizro-ai/mkdocs.yml b/vizro-ai/mkdocs.yml index 845af6190..f67dd0cd0 100644 --- a/vizro-ai/mkdocs.yml +++ b/vizro-ai/mkdocs.yml @@ -18,9 +18,9 @@ nav: # - Contributing: pages/contribute/contributing.md - Authors: pages/contribute/authors.md -#TODO: this infers the version number of the latest release of whole repo -#repo_url: https://github.com/mckinsey/vizro/tree/main/vizro-ai -#repo_name: mckinsey/vizro-ai +# This infers the version number of the latest release of whole repo, so we're hiding it for sub-packed in extra.css +repo_url: https://github.com/mckinsey/vizro/tree/main/vizro-ai +repo_name: mckinsey/vizro-ai theme: name: material diff --git a/vizro-ai/src/vizro_ai/_vizro_ai.py b/vizro-ai/src/vizro_ai/_vizro_ai.py index d467b8b3b..622f4421f 100644 --- a/vizro-ai/src/vizro_ai/_vizro_ai.py +++ b/vizro-ai/src/vizro_ai/_vizro_ai.py @@ -41,7 +41,8 @@ def __init__(self, model_name: str = "gpt-3.5-turbo-0613", temperature: int = 0) f"You have selected {self.model_name}," f"Engaging with LLMs (Large Language Models) carries certain risks. " f"Users are advised to become familiar with these risks to make informed decisions, " - f"and visit this page for detailed information:docs/pages/disclaimer.md(change to URL after docs is hosted)" + f"and visit this page for detailed information: " + "https://vizro-ai.readthedocs.io/en/latest/pages/explanation/disclaimer/" ) @property