merge

.github/workflows/checks-vizro-ai.yml

@@ -41,9 +41,6 @@ jobs:
       - name: List dependencies
         run: hatch run all.py${{ env.PYTHON_VERSION }}:pip freeze
 
-      - name: Check requirements for Snyk are up to date
-        run: hatch run all.py${{ env.PYTHON_VERSION }}:update-snyk-requirements --check
-
       - name: Find changed files to see if changelog fragment needed
         id: changed-files
         if: ${{ github.event_name == 'pull_request' }}

.github/workflows/checks-vizro-core.yml

@@ -44,9 +44,6 @@ jobs:
       - name: Check schema is up to date
         run: hatch run all.py${{ env.PYTHON_VERSION }}:schema --check
 
-      - name: Check requirements for Snyk are up to date
-        run: hatch run all.py${{ env.PYTHON_VERSION }}:update-snyk-requirements --check
-
       - name: Find changed files to see if changelog fragment needed
         id: changed-files
         if: ${{ github.event_name == 'pull_request' }}

.vale/styles/Microsoft/Headings.yml

@@ -72,6 +72,7 @@ exceptions:
   - Pandas
   - Plotly
   - Pydantic
+  - Py.Cafe
   - Python
   - QuantumBlack
   - QuantumBlack Labs

.vale/styles/Microsoft/ignore.txt

@@ -64,7 +64,6 @@ css
 dataframes
 Javascript
 tooltip
-Snyk
 Codespaces
 dev
 mypy

README.md

@@ -23,7 +23,7 @@
 
 <a href="https://vizro.readthedocs.io/en/stable/" target="_blank">Documentation </a> |
 <a href="https://vizro.readthedocs.io/en/stable/pages/tutorials/first_dashboard/" target="_blank">Get Started </a> |
-<a href="http://vizro.mckinsey.com/" target="_blank">Live Demo </a>
+<a href="http://vizro.mckinsey.com/" target="_blank">Vizro examples gallery</a>
 
 </div>
 
@@ -98,16 +98,16 @@ See the [Vizro-AI documentation](https://vizro.readthedocs.io/projects/vizro-ai/
 
 <br/>
 
-## Live demo
+## Vizro examples gallery
 
-You can see Vizro in action by clicking on the following image or by visiting [vizro.mckinsey.com](https://vizro.mckinsey.com).
+You can see Vizro in action by clicking on the following image or by visiting [the examples gallery at vizro.mckinsey.com](https://vizro.mckinsey.com).
 
 <p align="left">
 <a href="http://vizro.mckinsey.com/">
-<img border="0" src="https://raw.githubusercontent.com/mckinsey/vizro/main/.github/images/live_interactive_demo.png" width="525" height="296">  </a>
+<img border="0" src="https://raw.githubusercontent.com/mckinsey/vizro/main/.github/images/vizro_examples_gallery.png" width="525" height="296">  </a>
 </p>
 
-## Examples
+## Dashboard screenshots
 
 <p align="center">
 <img src="https://raw.githubusercontent.com/mckinsey/vizro/main/.github/images/dashboard_examples.png" width="1300"/>

pyproject.toml

@@ -69,7 +69,7 @@ ignore = [
   # D407 needs to be ignored as it otherwise messes up the formatting in our API docs
   "D407"  # missing dashed underline after section
 ]
-ignore-init-module-imports = true
+ignore-init-module-imports = true  # TODO: remove as deprecated soon
 select = [
   "E",  # pycodestyle errors
   "W",  # pycodestyle warnings
@@ -91,5 +91,5 @@ select = [
 "**/tests/**" = ["PLR2004", "S101", "TID252", "D100", "D101", "D102", "D103", "PLC1901", "RUF012"]
 # Ignore import violations in all __init__.py files
 "__init__.py" = ["E402", "F401"]
-# Ignore missing docstrings in chart gallery examples to keep them succinct.
-"vizro-core/examples/_chart-gallery/pages/examples/**" = ["D100", "D103"]
+# Ignore missing docstrings in visual-vocabulary examples to keep them succinct.
+"vizro-core/examples/_visual-vocabulary/pages/examples/**" = ["D100", "D103"]

vizro-ai/CHANGELOG.md

@@ -11,6 +11,26 @@ See the fragment files in the [changelog.d directory](https://github.com/mckinse
 
 <!-- scriv-insert-here -->
 
+<a id='changelog-0.2.1'></a>
+
+# 0.2.1 — 2024-08-28
+
+## Removed
+
+- Remove `_return_all_text` from `VizroAI` class ([#518](https://github.com/mckinsey/vizro/pull/518))
+
+## Added
+
+- Add argument `return_elements` to`VizroAI.plot()`. When it is set to `True`, the return type will be changed to a `dataclass` containing the code string, figure object, business insights, and code explanation. ([#488](https://github.com/mckinsey/vizro/pull/488))
+
+- Add functionality to generate dashboards from text. This feature is currently in **Alpha** and is not yet officially released ([#651](https://github.com/mckinsey/vizro/pull/651))
+
+## Changed
+
+- Disabled figure display upon variable assignment. To display outcome of `VizroAI.plot()` add `.show()`. ([#527](https://github.com/mckinsey/vizro/pull/527))
+
+- Stabilized `plot` performance by addressing several dataframe mutation issues. ([#603](https://github.com/mckinsey/vizro/pull/603))
+
 <a id='changelog-0.2.0'></a>
 
 # 0.2.0 — 2024-05-09

vizro-ai/README.md

@@ -19,6 +19,12 @@ It serves as an extension to Vizro, leveraging natural language capabilities to
 
 </div>
 
+## Try out live
+
+| Platform     | Chart creation                                                                                                                                                                            | Dashboard creation                                                                                                                                                                            |
+| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Google Colab | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/mckinsey/vizro/blob/main/vizro-ai/examples/chart_by_vizro_ai.ipynb) | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/mckinsey/vizro/blob/main/vizro-ai/examples/dashboard_by_vizro_ai.ipynb) |
+
 ## Why Vizro-AI?
 
 ### Easy-to-use