Merge branch 'main' into docs/admonition-review

mckinsey · Jul 8, 2024 · 337dfbe · 337dfbe
2 parents d8791cf + 060ca69
commit 337dfbe
Show file tree

Hide file tree

Showing 12 changed files with 392 additions and 115 deletions.
diff --git a/vizro-ai/changelog.d/20240626_224646_anna_xiong_azure_openai.md b/vizro-ai/changelog.d/20240626_224646_anna_xiong_azure_openai.md
@@ -0,0 +1,48 @@
+<!--
+A new scriv changelog fragment.
+
+Uncomment the section that is right (remove the HTML comment wrapper).
+-->
+
+<!--
+### Highlights ✨
+
+- A bullet item for the Highlights ✨ category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Removed
+
+- A bullet item for the Removed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Added
+
+- A bullet item for the Added category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Changed
+
+- A bullet item for the Changed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Deprecated
+
+- A bullet item for the Deprecated category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Fixed
+
+- A bullet item for the Fixed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Security
+
+- A bullet item for the Security category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
diff --git a/vizro-ai/changelog.d/20240705_153310_lingyi_zhang_vizroai_models.md b/vizro-ai/changelog.d/20240705_153310_lingyi_zhang_vizroai_models.md
@@ -0,0 +1,48 @@
+<!--
+A new scriv changelog fragment.
+
+Uncomment the section that is right (remove the HTML comment wrapper).
+-->
+
+<!--
+### Highlights ✨
+
+- A bullet item for the Highlights ✨ category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Removed
+
+- A bullet item for the Removed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Added
+
+- A bullet item for the Added category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Changed
+
+- A bullet item for the Changed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Deprecated
+
+- A bullet item for the Deprecated category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Fixed
+
+- A bullet item for the Fixed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Security
+
+- A bullet item for the Security category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
diff --git a/vizro-ai/docs/pages/user-guides/customize-vizro-ai.md b/vizro-ai/docs/pages/user-guides/customize-vizro-ai.md
@@ -3,20 +3,35 @@
 ## Supported models
 Vizro-AI currently supports [OpenAI models](https://platform.openai.com/docs/models) as follows, although we are working on supporting more vendors:
 
-- `gpt-3.5-turbo` (default model)
-- `gpt-4-turbo` (recommended for best model performance)
-- `gpt-3.5-turbo-0125`
-- `gpt-3.5-turbo-1106`
-- `gpt-4-0613`
-- `gpt-4-1106-preview`
-- `gpt-3.5-turbo-0613` (to be deprecated on June 13, 2024)
+=== "OpenAI"
+
+    - gpt-3.5-turbo `default`
+    - gpt-4-turbo
+    - gpt-4o
+    - gpt-4
+    - gpt-4-0613
+    - gpt-4-1106-preview
+    - gpt-4-turbo-2024-04-09
+    - gpt-4-turbo-preview
+    - gpt-4-0125-preview
+    - gpt-3.5-turbo-1106
+    - gpt-3.5-turbo-0125
+    - gpt-4o-2024-05-13
+
+=== "Anthropic"
+
+    :octicons-hourglass-24: In development
+
+=== "MistralAI"
+
+    :octicons-hourglass-24: In development
 
 
 These models offer different levels of performance and cost to Vizro-AI users:
 
-* The **gpt-3.5** model series have lower price point and higher speeds for providing answers, but do not offer sophisticated charting.
+* The **gpt-3.5** model series have lower price points and faster speeds for providing answers, but do not offer sophisticated charting.
 
-* Consider upgrading to the **gpt-4** models for more demanding tasks. While they are part of a more capable GPT model series, their response time is slower than gpt-3.5 models, and they come at a higher cost.
+* Consider upgrading to the **gpt-4** and **gpt-4o** model series for more demanding tasks. While they are part of a more capable GPT model series, they come at a higher cost.
 
 Refer to the [OpenAI documentation for more about model capabilities](https://platform.openai.com/docs/models/overview) and [pricing](https://openai.com/pricing).
 
@@ -36,10 +51,10 @@ The example below uses the OpenAI model name in a string form:
         ```py linenums="1"
         from vizro_ai import VizroAI
 
-        vizro_ai = VizroAI(model="gpt-3.5-turbo-0125")
+        vizro_ai = VizroAI(model="gpt-4-turbo")
         ```
 
-The example below customizes the `ChatOpenAI` instance further beyond the chosen default from the string instantiation. We pass the `"gpt-3.5-turbo-0125"` model from OpenAI as `model_name` for `ChatOpenAI`, which offers improved response accuracy, we also want to increase maximum number of retries.
+The example below customizes the `ChatOpenAI` instance further beyond the chosen default from the string instantiation. We pass the `"gpt-4-turbo"` model from OpenAI as `model_name` for `ChatOpenAI`, which offers improved response accuracy, we also want to increase maximum number of retries.
 It's important to mention that any parameter that could be used in the `openai.create` call is also usable in `ChatOpenAI`. For more customization options for `ChatOpenAI`, refer to the [LangChain ChatOpenAI docs](https://api.python.langchain.com/en/latest/chat_models/langchain_openai.chat_models.base.ChatOpenAI.html)
 
 <!-- vale off -->
@@ -57,7 +72,7 @@ To ensure a deterministic answer to our queries, we've set the temperature to 0.
         df = px.data.gapminder()
 
         llm = ChatOpenAI(
-            model_name="gpt-3.5-turbo-0125",
+            model_name="gpt-4-turbo",
             temperature=0,
             max_retries=5,
         )

diff --git a/vizro-ai/src/vizro_ai/chains/_llm_models.py b/vizro-ai/src/vizro_ai/chains/_llm_models.py
@@ -3,41 +3,29 @@
 from langchain_core.language_models.chat_models import BaseChatModel
 from langchain_openai import ChatOpenAI
 
-# TODO constant of model inventory, can be converted to yaml and link to docs
-PREDEFINED_MODELS: Dict[str, Dict[str, Union[int, BaseChatModel]]] = {
-    "gpt-3.5-turbo-0613": {
-        "max_tokens": 4096,
-        "wrapper": ChatOpenAI,
-    },
-    "gpt-4-0613": {
-        "max_tokens": 8192,
-        "wrapper": ChatOpenAI,
-    },
-    "gpt-3.5-turbo-1106": {
-        "max_tokens": 16385,
-        "wrapper": ChatOpenAI,
-    },
-    "gpt-4-1106-preview": {
-        "max_tokens": 128000,
-        "wrapper": ChatOpenAI,
-    },
-    "gpt-3.5-turbo-0125": {
-        "max_tokens": 16385,
-        "wrapper": ChatOpenAI,
-    },
-    "gpt-3.5-turbo": {
-        "max_tokens": 16385,
-        "wrapper": ChatOpenAI,
-    },
-    "gpt-4-turbo": {
-        "max_tokens": 128000,
-        "wrapper": ChatOpenAI,
-    },
+SUPPORTED_MODELS = {
+    "OpenAI": [
+        "gpt-4-0613",
+        "gpt-4",
+        "gpt-4-1106-preview",
+        "gpt-4-turbo",
+        "gpt-4-turbo-2024-04-09",
+        "gpt-4-turbo-preview",
+        "gpt-4-0125-preview",
+        "gpt-3.5-turbo-1106",
+        "gpt-3.5-turbo-0125",
+        "gpt-3.5-turbo",
+        "gpt-4o-2024-05-13",
+        "gpt-4o",
+    ]
 }
 
+DEFAULT_WRAPPER_MAP: Dict[str, BaseChatModel] = {"OpenAI": ChatOpenAI}
 DEFAULT_MODEL = "gpt-3.5-turbo"
 DEFAULT_TEMPERATURE = 0
 
+model_to_vendor = {model: key for key, models in SUPPORTED_MODELS.items() for model in models}
+
 
 def _get_llm_model(model: Optional[Union[ChatOpenAI, str]] = None) -> BaseChatModel:
     """Fetches and initializes an instance of the LLM.
@@ -54,14 +42,21 @@ def _get_llm_model(model: Optional[Union[ChatOpenAI, str]] = None) -> BaseChatMo
     """
     if not model:
         return ChatOpenAI(model_name=DEFAULT_MODEL, temperature=DEFAULT_TEMPERATURE)
-    if isinstance(model, ChatOpenAI):
+
+    if isinstance(model, BaseChatModel):
         return model
-    if isinstance(model, str) and model in PREDEFINED_MODELS:
-        return PREDEFINED_MODELS.get(model)["wrapper"](model_name=model, temperature=DEFAULT_TEMPERATURE)
+
+    if isinstance(model, str):
+        if any(model in model_list for model_list in SUPPORTED_MODELS.values()):
+            vendor = model_to_vendor[model]
+            return DEFAULT_WRAPPER_MAP.get(vendor)(model_name=model, temperature=DEFAULT_TEMPERATURE)
+
     raise ValueError(
-        f"Model {model} not found! List of available model can be found at https://vizro.readthedocs.io/projects/vizro-ai/en/latest/pages/explanation/faq/#which-llms-are-supported-by-vizro-ai"
+        f"Model {model} not found! List of available model can be found at https://vizro.readthedocs.io/projects/vizro-ai/en/latest/pages/user-guides/customize-vizro-ai/#supported-models"
     )
 
 
 if __name__ == "__main__":
-    llm_chat_openai = _get_llm_model()
+    llm_chat_openai = _get_llm_model(model="gpt-3.5-turbo")
+    print(repr(llm_chat_openai))  # noqa: T201
+    print(llm_chat_openai.model_name)  # noqa: T201
diff --git a/vizro-core/changelog.d/20240703_091955_huong_li_nguyen_fix_selector_return_type.md b/vizro-core/changelog.d/20240703_091955_huong_li_nguyen_fix_selector_return_type.md
@@ -0,0 +1,47 @@
+<!--
+A new scriv changelog fragment.
+
+Uncomment the section that is right (remove the HTML comment wrapper).
+-->
+
+<!--
+### Highlights ✨
+
+- A bullet item for the Highlights ✨ category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Removed
+
+- A bullet item for the Removed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Added
+
+- A bullet item for the Added category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Changed
+
+- A bullet item for the Changed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Deprecated
+
+- A bullet item for the Deprecated category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+
+### Fixed
+
+- Ensure that categorical selectors always return a list of values. ([#562](https://github.com/mckinsey/vizro/pull/562))
+
+<!--
+### Security
+
+- A bullet item for the Security category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
diff --git a/vizro-core/changelog.d/20240708_105029_huong_li_nguyen_fix_default_nav_items.md b/vizro-core/changelog.d/20240708_105029_huong_li_nguyen_fix_default_nav_items.md
@@ -0,0 +1,47 @@
+<!--
+A new scriv changelog fragment.
+
+Uncomment the section that is right (remove the HTML comment wrapper).
+-->
+
+<!--
+### Highlights ✨
+
+- A bullet item for the Highlights ✨ category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Removed
+
+- A bullet item for the Removed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Added
+
+- A bullet item for the Added category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Changed
+
+- A bullet item for the Changed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Deprecated
+
+- A bullet item for the Deprecated category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+
+### Fixed
+
+- Remove default icon provision for `vm.NavLink` when the icon count exceeds 9 and a user icon is provided.([#571](https://github.com/mckinsey/vizro/pull/571))
+
+<!--
+### Security
+
+- A bullet item for the Security category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->