docs: deprecate default model in `TextEmbedddingGenerator`, `GeminiTextGenerator`, and other `bigframes.ml.llm` classes #1570

shuoweil · 2025-03-28T22:25:02Z

docs: add remove default model warning, default LLM model will be removed for Bigframes 3.0

bigframes/ml/llm.py

shuoweil · 2025-04-09T21:38:08Z

failing notebook is not relevant to this change, please help me with the review @tswast @shobsi @GarrettWu

tswast

FYI: I updated the PR title to reflect what we're doing in a way the user would understand.

bigframes/ml/llm.py

tswast

Looks good, thank you!

Let's make sure these code paths are covered by tests, such as by adding unit tests that check that the warning is issued at construction time.

For example:

python-bigquery-dataframes/tests/unit/ml/test_matrix_factorization.py

Lines 49 to 65 in b03e44f

    
           def test_decomposition_mf_invalid_feedback_type_raises(): 
        
               feedback_type = "explimp" 
        
               with pytest.raises( 
        
                   ValueError, 
        
                   match="Expected feedback_type to be `explicit` or `implicit`.", 
        
               ): 
        
                   decomposition.MatrixFactorization( 
        
                       # Intentionally pass in the wrong type. This will fail if the user is using 
        
                       # a type checker, but we can't assume that everyone is doing so, especially 
        
                       # not in notebook environments. 
        
                       num_factors=16, 
        
                       feedback_type=feedback_type,  # type: ignore 
        
                       user_col="user_id", 
        
                       item_col="item_col", 
        
                       rating_col="rating_col", 
        
                       l2_reg=9.83, 
        
                   )

but in this case, use pytest.warns instead.

…t model and raise warning

shobsi · 2025-04-16T01:29:12Z

May I suggest the title:

chore: warn if default llm is used in bigframes.ml.llm classes

shuoweil · 2025-04-16T17:08:44Z

chore: warn if default llm is used in bigframes.ml.llm classes

Thanks @shobsi for the suggestion. I believe both of the title looks great. Adding @tswast for discussion.

tswast · 2025-04-16T21:54:22Z

@shobsi We don't want to use chore: because we want this to be in the changelog. chore: should be reserved for changes that don't affect user-facing behaviors like refactors and test infrastructure.

shobsi · 2025-04-17T18:39:42Z

@shobsi We don't want to use chore: because we want this to be in the changelog. chore: should be reserved for changes that don't affect user-facing behaviors like refactors and test infrastructure.

Ack, feat: would make more sense, but the main point was to shorten the long title

shuoweil requested review from tswast and GarrettWu March 28, 2025 22:25

shuoweil self-assigned this Mar 28, 2025

shuoweil requested review from a team as code owners March 28, 2025 22:25

product-auto-label bot added size: s Pull request size is small. api: bigquery Issues related to the googleapis/python-bigquery-dataframes API. labels Mar 28, 2025

shuoweil removed request for tswast and GarrettWu March 29, 2025 04:52

shuoweil marked this pull request as draft March 29, 2025 04:52

shuoweil force-pushed the shuowei-add-default-model-warning branch from f6c59f4 to 1e9fd7a Compare March 31, 2025 22:16

shuoweil requested review from tswast and GarrettWu March 31, 2025 23:37

shuoweil marked this pull request as ready for review March 31, 2025 23:37

shuoweil force-pushed the shuowei-add-default-model-warning branch from 1e9fd7a to c72346a Compare April 1, 2025 17:41

shuoweil requested a review from shobsi April 1, 2025 20:14

shuoweil marked this pull request as draft April 1, 2025 22:14

tswast reviewed Apr 2, 2025

View reviewed changes

bigframes/ml/llm.py Outdated Show resolved Hide resolved

bigframes/ml/llm.py Outdated Show resolved Hide resolved

shuoweil force-pushed the shuowei-add-default-model-warning branch from c72346a to 3c77d3c Compare April 8, 2025 03:23

shuoweil requested a review from tswast April 8, 2025 17:19

shuoweil marked this pull request as ready for review April 8, 2025 17:20

shuoweil force-pushed the shuowei-add-default-model-warning branch from 3c77d3c to 81cb659 Compare April 8, 2025 21:50

tswast changed the title ~~docs: add remove default model warning~~ docs: deprecate default model in TextEmbedddingGenerator, GeminiTextGenerator, and other bigframes.ml.llm classes Apr 10, 2025

tswast requested changes Apr 10, 2025

View reviewed changes

bigframes/ml/llm.py Outdated Show resolved Hide resolved

shuoweil force-pushed the shuowei-add-default-model-warning branch from 81cb659 to b58fa9c Compare April 10, 2025 19:58

product-auto-label bot added size: m Pull request size is medium. and removed size: s Pull request size is small. labels Apr 10, 2025

shuoweil requested a review from tswast April 10, 2025 20:17

tswast reviewed Apr 11, 2025

View reviewed changes

shuoweil added 6 commits April 15, 2025 21:24

docs: add remove default model warning

54d702e

remove unnecessary warnings

1fbed70

add a new warning

3808bbe

update warning methods

34eba0f

change the default model to None, when None is provide, change defaul…

380c952

…t model and raise warning

add a testcase to test warning message

cb1b0c4

shuoweil force-pushed the shuowei-add-default-model-warning branch from b58fa9c to cb1b0c4 Compare April 15, 2025 21:25

shuoweil requested a review from tswast April 15, 2025 21:26

tswast approved these changes Apr 16, 2025

View reviewed changes

shuoweil merged commit 89ab33e into main Apr 16, 2025
24 checks passed

shuoweil deleted the shuowei-add-default-model-warning branch April 16, 2025 21:57

release-please bot mentioned this pull request Apr 16, 2025

chore(main): release 2.0.0 #1552

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: deprecate default model in `TextEmbedddingGenerator`, `GeminiTextGenerator`, and other `bigframes.ml.llm` classes #1570

docs: deprecate default model in `TextEmbedddingGenerator`, `GeminiTextGenerator`, and other `bigframes.ml.llm` classes #1570

shuoweil commented Mar 28, 2025

shuoweil commented Apr 9, 2025 •

edited

Loading

tswast left a comment

tswast left a comment

shobsi commented Apr 16, 2025

shuoweil commented Apr 16, 2025

tswast commented Apr 16, 2025

shobsi commented Apr 17, 2025

	def test_decomposition_mf_invalid_feedback_type_raises():
	feedback_type = "explimp"
	with pytest.raises(
	ValueError,
	match="Expected feedback_type to be `explicit` or `implicit`.",
	):
	decomposition.MatrixFactorization(
	# Intentionally pass in the wrong type. This will fail if the user is using
	# a type checker, but we can't assume that everyone is doing so, especially
	# not in notebook environments.
	num_factors=16,
	feedback_type=feedback_type, # type: ignore
	user_col="user_id",
	item_col="item_col",
	rating_col="rating_col",
	l2_reg=9.83,
	)

docs: deprecate default model in TextEmbedddingGenerator, GeminiTextGenerator, and other bigframes.ml.llm classes #1570

docs: deprecate default model in TextEmbedddingGenerator, GeminiTextGenerator, and other bigframes.ml.llm classes #1570

Conversation

shuoweil commented Mar 28, 2025

shuoweil commented Apr 9, 2025 • edited Loading

tswast left a comment

Choose a reason for hiding this comment

tswast left a comment

Choose a reason for hiding this comment

shobsi commented Apr 16, 2025

shuoweil commented Apr 16, 2025

tswast commented Apr 16, 2025

shobsi commented Apr 17, 2025

docs: deprecate default model in `TextEmbedddingGenerator`, `GeminiTextGenerator`, and other `bigframes.ml.llm` classes #1570

docs: deprecate default model in `TextEmbedddingGenerator`, `GeminiTextGenerator`, and other `bigframes.ml.llm` classes #1570

shuoweil commented Apr 9, 2025 •

edited

Loading