Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix LangChain compatibility with SQLDatabase #9192

Merged
merged 12 commits into from
Aug 2, 2023

Conversation

dbczumar
Copy link
Collaborator

@dbczumar dbczumar commented Aug 1, 2023

Related Issues/PRs

Fixes #9188

What changes are proposed in this pull request?

Fix LangChain compatibility with SQLDatabase

How is this patch tested?

  • Existing unit/integration tests
  • New unit/integration tests
  • Manual tests (describe details, including test results, below)

Does this PR change the documentation?

  • No. You can skip the rest of this section.
  • Yes. Make sure the changed pages / sections render correctly in the documentation preview.

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.

(Details in 1-2 sentences. You can just refer to another PR with a description if this PR is part of a larger change.)

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

Components

  • area/artifacts: Artifact stores and artifact logging
  • area/build: Build and test infrastructure for MLflow
  • area/docs: MLflow documentation pages
  • area/examples: Example code
  • area/gateway: AI Gateway service, Gateway client APIs, third-party Gateway integrations
  • area/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
  • area/models: MLmodel format, model serialization/deserialization, flavors
  • area/recipes: Recipes, Recipe APIs, Recipe configs, Recipe Templates
  • area/projects: MLproject format, project running backends
  • area/scoring: MLflow Model server, model deployment tools, Spark UDFs
  • area/server-infra: MLflow Tracking server backend
  • area/tracking: Tracking Service, tracking client APIs, autologging

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/breaking-change - The PR will be mentioned in the "Breaking Changes" section
  • 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/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

Signed-off-by: dbczumar <[email protected]>
Signed-off-by: dbczumar <[email protected]>
Signed-off-by: dbczumar <[email protected]>
Signed-off-by: dbczumar <[email protected]>
Signed-off-by: dbczumar <[email protected]>
@mlflow-automation
Copy link
Collaborator

mlflow-automation commented Aug 2, 2023

Documentation preview for 2da6697 will be available here when this CircleCI job completes successfully.

More info

@github-actions github-actions bot added area/models MLmodel format, model serialization/deserialization, flavors rn/bug-fix Mention under Bug Fixes in Changelogs. labels Aug 2, 2023
Signed-off-by: dbczumar <[email protected]>
Signed-off-by: dbczumar <[email protected]>
Signed-off-by: dbczumar <[email protected]>
):
logger.warning(
_UNSUPPORTED_LLM_WARNING_MESSAGE,
type(lc_model.llm).__name__,
)

if (
isinstance(lc_model, langchain.agents.agent.AgentExecutor)
and type(lc_model.agent.llm_chain.llm) not in _SUPPORTED_LLMS
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is quite brittle, since it doesn't support subclasses. Changed to isinstance().

):
logger.warning(
_UNSUPPORTED_LLM_WARNING_MESSAGE,
type(lc_model.agent.llm_chain.llm).__name__,
)

if type(lc_model).__name__ in special_chains:
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is quite brittle, since it doesn't support subclasses. Changed to isinstance() in _get_special_chain_info_or_none

model = None
if key := special_chains.get(model_type):
Copy link
Collaborator Author

@dbczumar dbczumar Aug 2, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This breaks for subclasses of special chains. It also breaks if the chain class name changes in a future version of langchain. Accordingly, rather than relying on the class name, we store the name of the loader argument for dependent objects (e.g. embeddings, database, ...) as part of the MLModel flavor config for improved compatibility across versions.

@@ -68,6 +70,7 @@
_MODEL_TYPE_KEY = "model_type"
_LOADER_FN_FILE_NAME = "loader_fn.pkl"
_LOADER_FN_KEY = "loader_fn"
_LOADER_ARG_KEY = "loader_arg"
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Signed-off-by: dbczumar <[email protected]>
Signed-off-by: dbczumar <[email protected]>
Signed-off-by: dbczumar <[email protected]>
Signed-off-by: dbczumar <[email protected]>
Comment on lines +514 to +532
def test_log_and_load_subclass_of_specialized_chain():
class APIChainSubclass(APIChain):
pass

llm = OpenAI(temperature=0)
apichain_subclass = APIChainSubclass.from_llm_and_api_docs(
llm, open_meteo_docs.OPEN_METEO_DOCS, verbose=True
)

with mlflow.start_run():
logged_model = mlflow.langchain.log_model(
apichain_subclass,
"apichain_subclass",
loader_fn=load_requests_wrapper,
)

# Load the chain
loaded_model = mlflow.langchain.load_model(logged_model.model_uri)
assert loaded_model == apichain_subclass
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This fails on master with:

   def _load_api_chain(config: dict, **kwargs: Any) -> APIChain:
        if "api_request_chain" in config:
            api_request_chain_config = config.pop("api_request_chain")
            api_request_chain = load_chain_from_config(api_request_chain_config)
        elif "api_request_chain_path" in config:
            api_request_chain = load_chain(config.pop("api_request_chain_path"))
        else:
            raise ValueError(
                "One of `api_request_chain` or `api_request_chain_path` must be present."
            )
        if "api_answer_chain" in config:
            api_answer_chain_config = config.pop("api_answer_chain")
            api_answer_chain = load_chain_from_config(api_answer_chain_config)
        elif "api_answer_chain_path" in config:
            api_answer_chain = load_chain(config.pop("api_answer_chain_path"))
        else:
            raise ValueError(
                "One of `api_answer_chain` or `api_answer_chain_path` must be present."
            )
        if "requests_wrapper" in kwargs:
            requests_wrapper = kwargs.pop("requests_wrapper")
        else:
>           raise ValueError("`requests_wrapper` must be present.")
E           ValueError: `requests_wrapper` must be present.

But it passes on the PR branch :)

Copy link
Collaborator

@serena-ruan serena-ruan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@dbczumar dbczumar merged commit 6471238 into mlflow:master Aug 2, 2023
santiagxf pushed a commit to santiagxf/mlflow that referenced this pull request Aug 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/models MLmodel format, model serialization/deserialization, flavors rn/bug-fix Mention under Bug Fixes in Changelogs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] cannot import name 'SQLDatabaseChain' from 'langchain.chains'
3 participants