Support file paths for model_config in langchain #11843

annzhang-db · 2024-04-27T00:26:55Z

🛠 DevTools 🛠

Install mlflow from this PR

pip install git+https://github.com/mlflow/mlflow.git@refs/pull/11843/merge

Checkout with GitHub CLI

gh pr checkout 11843

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Add support for file paths (model_config) in langchain
Note: This PR does NOT add support for file_paths in model_config for pyfunc (to follow soon). It also does not support dict for model_config in langchain (this will be a fast follow along with supporting dict in ModelConfig).

How is this PR tested?

Existing unit/integration tests
New unit/integration tests
Manual tests

Does this PR require documentation update?

Release Notes

Is this a user-facing change?

No. You can skip the rest of this section.
Yes. Give a description of this change to be included in the release notes for MLflow users.

What component(s), interfaces, languages, and integrations does this PR affect?

Components

Interface

area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev server
area/docker: Docker use across MLflow's components, such as MLflow Projects and MLflow Models
area/sqlalchemy: Use of SQLAlchemy in the Tracking Service or Model Registry
area/windows: Windows support

Language

language/r: R APIs and clients
language/java: Java APIs and clients
language/new: Proposals for new client languages

Integrations

integrations/azure: Azure and Azure ML integrations
integrations/sagemaker: SageMaker integrations
integrations/databricks: Databricks integrations

How should the PR be classified in the release notes? Choose one:

rn/none - No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" section
rn/breaking-change - The PR will be mentioned in the "Breaking Changes" section
rn/feature - A new user-facing feature worth mentioning in the release notes
rn/bug-fix - A user-facing bug fix worth mentioning in the release notes
rn/documentation - A user-facing documentation change worth mentioning in the release notes

Should this PR be included in the next patch release?

Yes should be selected for bug fixes, documentation updates, and other small changes. No should be selected for new features and larger changes. If you're unsure about the release classification of this PR, leave this unchecked to let the maintainers decide.

What is a minor/patch release?

Minor release: a release that increments the second part of the version number (e.g., 1.2.0 -> 1.3.0).
Bug fixes, doc updates and new features usually go into minor releases.
Patch release: a release that increments the third part of the version number (e.g., 1.2.0 -> 1.2.1).
Bug fixes and doc updates usually go into patch releases.

Yes (this PR will be cherry-picked and included in the next patch release)
No (this PR will be included in the next minor release)

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

github-actions · 2024-04-27T00:27:23Z

Documentation preview for f876a43 will be available when this CircleCI job
completes successfully.

More info

Ignore this comment if this PR does not change the documentation.
It takes a few minutes for the preview to be available.
The preview is updated when a new commit is pushed to this PR.
This comment was created by https://github.com/mlflow/mlflow/actions/runs/8898529766.

WeichenXu123 · 2024-04-29T04:05:48Z

mlflow/langchain/__init__.py

+            model_code_paths.append(model_config_path)
+
+    code_dir_subpath = _validate_and_copy_code_paths(code_paths, path)
+    model_code_dir_subpath = _validate_and_copy_model_code_paths(model_code_paths, path)


According to https://github.com/mlflow/mlflow/pull/11843/files#r1582520059

then we should update verification here to just check the path file existence.

WeichenXu123

LGTM after addressing remaining few comments.

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

annzhang-db · 2024-04-30T04:58:34Z

mlflow/langchain/__init__.py

@@ -356,7 +372,6 @@ def load_retriever(persist_directory):
        FLAVOR_NAME,
        langchain_version=langchain.__version__,
        code=code_dir_subpath,
-        model_code=model_code_dir_subpath,


model code path is directly captured in the flavor_conf

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

sunishsheth2009 · 2024-04-29T16:43:31Z

mlflow/models/model_config.py



+# Should we allow ModelConfig to take in dict?


Isn't the development_config already taking the code as dict?

Hmm... I remember that from somewhere but don't see it in this code?

I think this logic is in log_model and it writes to a file which is passed to ModelConfig, so it wasn't ported over. We will need to put it somewhere but plan to do all the support for dict as a follow-up.

mlflow/langchain/__init__.py

sunishsheth2009 · 2024-04-30T05:23:48Z

mlflow/langchain/__init__.py

@@ -335,7 +350,8 @@ def load_retriever(persist_directory):
        code=code_dir_subpath,
        predict_stream_fn="predict_stream",
        streamable=streamable,
-        model_code=model_code_dir_subpath,
+        model_code=model_code_path,


I think previous this was the path to the folder and now its path to the file. Do we want it to be the path of the folder similar to before?

Re: Weichen's comment, we decided to make this a path to the file unlike code_paths since we will only have 1) the code file and 2) the config file.

Suggested change

model_code=model_code_path,

model_code_path=model_code_path,

to keep consistent with the key name in flavor_conf

mlflow/langchain/__init__.py

sunishsheth2009 · 2024-04-30T05:28:10Z

mlflow/models/model_config.py

-        self.config_path = _mlflow_rag_config_path or development_config
+        config = globals().get("__mlflow_model_config__", None)
+        # backwards compatibility
+        rag_config = globals().get("__databricks_rag_config_path__", None)


Where is this global set?
Do we need to use mlflow.langchain._rag_utils or something?

It will get set when loading the model - I think if the versions are out of sync there could be some issues. Let's leave this in? I also added setting both globals for now.

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

WeichenXu123 · 2024-04-30T08:58:20Z

mlflow/langchain/__init__.py

@@ -133,6 +136,7 @@ def save_model(
    loader_fn=None,
    persist_dir=None,
    example_no_conversion=False,
+    model_config=None,


model_config param doc is lost

mlflow/langchain/__init__.py

WeichenXu123

LGTM after few comments :)

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

sunishsheth2009

LGTM

sunishsheth2009 · 2024-04-30T16:38:40Z

@mlflow-automation autoformat

Signed-off-by: mlflow-automation <mlflow-automation@users.noreply.github.com>

Signed-off-by: Ann Zhang <ann.zhang@databricks.com> Signed-off-by: mlflow-automation <mlflow-automation@users.noreply.github.com> Co-authored-by: mlflow-automation <mlflow-automation@users.noreply.github.com>

annzhang-db added 25 commits April 24, 2024 16:52

initial

767e92e

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

set chain

464d885

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

format

0190276

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

format again

208ab5e

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

update

f417867

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

docstring

c3b769b

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

update

d052868

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

update chain.py

776e425

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

catch all exceptions

5702feb

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

check code_paths existence

6ced8b2

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

tests

62c38e8

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

exception

5bca18b

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

update

f9ac68c

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

use model_code_dir_subpath

e319bb0

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

add test for different name

e8643d8

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

format

67c4d5b

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

leave code_paths as none

6a48b9a

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

.py suffix

c7bb50a

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

rework temp file

c34d9e0

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

remove import

48fd538

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

remove set_chain

5b10dd5

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

add back code_paths validation

9335648

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

format

246d963

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

Merge remote-tracking branch 'upstream/master' into langchain-log-model

f588fa8

initial

e73030f

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

annzhang-db mentioned this pull request Apr 27, 2024

Support log_model with code model in langchain #11817

Merged

39 tasks

github-actions bot added rn/none List under Small Changes in Changelogs. and removed rn/none List under Small Changes in Changelogs. labels Apr 27, 2024

annzhang-db requested a review from sunishsheth2009 April 27, 2024 00:46

WeichenXu123 reviewed Apr 29, 2024

View reviewed changes

annzhang-db added 8 commits April 29, 2024 09:50

import _set_model_config correctly

f3ae8b7

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

backwards compatibility

555974b

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

update chain file

db36e4d

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

fix

03ca1f2

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

update

5a7f2de

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

Merge remote-tracking branch 'upstream/master' into model-config-file

1fc13c3

fix test_model_config

e422641

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

update

091a0b7

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

github-actions bot added the patch-2.12.2 label Apr 30, 2024

fix

df5e50e

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

annzhang-db commented Apr 30, 2024

View reviewed changes

format

9ae5daa

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

sunishsheth2009 reviewed Apr 30, 2024

View reviewed changes

address comments

5d141bf

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

annzhang-db requested review from sunishsheth2009 and WeichenXu123 April 30, 2024 07:37

WeichenXu123 reviewed Apr 30, 2024

View reviewed changes

mlflow/langchain/__init__.py Show resolved Hide resolved

WeichenXu123 approved these changes Apr 30, 2024

View reviewed changes

annzhang-db added 2 commits April 30, 2024 09:27

docstring

f1d5efc

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

update documentation

e3a74c0

Signed-off-by: Ann Zhang <ann.zhang@databricks.com>

sunishsheth2009 approved these changes Apr 30, 2024

View reviewed changes

mlflow-automation added 2 commits April 30, 2024 16:42

Merge remote-tracking branch 'base/master' into model-config-file

600ac5d

Autoformat: https://github.com/mlflow/mlflow/actions/runs/8898481395

f876a43

Signed-off-by: mlflow-automation <mlflow-automation@users.noreply.github.com>

sunishsheth2009 enabled auto-merge (squash) April 30, 2024 16:56

sunishsheth2009 merged commit f60d23f into mlflow:master Apr 30, 2024
44 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support file paths for model_config in langchain #11843

Support file paths for model_config in langchain #11843

annzhang-db commented Apr 27, 2024 •

edited

github-actions bot commented Apr 27, 2024 •

edited

WeichenXu123 Apr 29, 2024

WeichenXu123 left a comment

annzhang-db Apr 30, 2024

sunishsheth2009 Apr 29, 2024

annzhang-db Apr 30, 2024

annzhang-db Apr 30, 2024 •

edited

sunishsheth2009 Apr 30, 2024

annzhang-db Apr 30, 2024 •

edited

WeichenXu123 Apr 30, 2024

sunishsheth2009 Apr 30, 2024

annzhang-db Apr 30, 2024 •

edited

WeichenXu123 Apr 30, 2024 •

edited

WeichenXu123 left a comment

sunishsheth2009 left a comment

sunishsheth2009 commented Apr 30, 2024

Support file paths for model_config in langchain #11843

Support file paths for model_config in langchain #11843

Conversation

annzhang-db commented Apr 27, 2024 • edited

Install mlflow from this PR

Checkout with GitHub CLI

Related Issues/PRs

What changes are proposed in this pull request?

How is this PR tested?

Does this PR require documentation update?

Release Notes

Is this a user-facing change?

What component(s), interfaces, languages, and integrations does this PR affect?

How should the PR be classified in the release notes? Choose one:

Should this PR be included in the next patch release?

github-actions bot commented Apr 27, 2024 • edited

WeichenXu123 Apr 29, 2024

Choose a reason for hiding this comment

WeichenXu123 left a comment

Choose a reason for hiding this comment

annzhang-db Apr 30, 2024

Choose a reason for hiding this comment

sunishsheth2009 Apr 29, 2024

Choose a reason for hiding this comment

annzhang-db Apr 30, 2024

Choose a reason for hiding this comment

annzhang-db Apr 30, 2024 • edited

Choose a reason for hiding this comment

sunishsheth2009 Apr 30, 2024

Choose a reason for hiding this comment

annzhang-db Apr 30, 2024 • edited

Choose a reason for hiding this comment

WeichenXu123 Apr 30, 2024

Choose a reason for hiding this comment

sunishsheth2009 Apr 30, 2024

Choose a reason for hiding this comment

annzhang-db Apr 30, 2024 • edited

Choose a reason for hiding this comment

WeichenXu123 Apr 30, 2024 • edited

Choose a reason for hiding this comment

WeichenXu123 left a comment

Choose a reason for hiding this comment

sunishsheth2009 left a comment

Choose a reason for hiding this comment

sunishsheth2009 commented Apr 30, 2024

annzhang-db commented Apr 27, 2024 •

edited

github-actions bot commented Apr 27, 2024 •

edited

annzhang-db Apr 30, 2024 •

edited

annzhang-db Apr 30, 2024 •

edited

annzhang-db Apr 30, 2024 •

edited

WeichenXu123 Apr 30, 2024 •

edited