langfun 0.1.2.dev202506240804__py3-none-any.whl → 0.1.2.dev202506260804__py3-none-any.whl

langfun/core/language_model.py

@@ -769,8 +769,25 @@ class LanguageModel(component.Component):
     cls._MODEL_FACTORY[model_id_or_prefix] = factory
 
   @classmethod
-  def get(cls, model_id: str, *args, **kwargs):
-    """Creates a language model instance from a model ID."""
+  def get(cls, model_str: str, *args, **kwargs) -> 'LanguageModel':
+    """Creates a language model instance from a model str.
+
+    Args:
+      model_str: A string that identifies the model. It can be a model ID or a
+        model ID with kwargs.
+        For example, "gpt-o3?temperature=0.1&n=2" will create a GPT-o3 model
+        with temperature set to 0.1 and n set to 2.
+      *args: Additional arguments to pass to the model factory.
+      **kwargs: Additional keyword arguments to pass to the model factory.
+        kwargs provided here will take precedence over kwargs parsed from
+        model_str.
+
+    Returns:
+      A language model instance.
+    """
+    model_id, model_kwargs = cls._parse_model_str(model_str)
+    model_kwargs.update(kwargs)
+
     factory = cls._MODEL_FACTORY.get(model_id)
     if factory is None:
       factories = []
@@ -786,11 +803,45 @@ class LanguageModel(component.Component):
             'Please specify a more specific model ID.'
         )
       factory = factories[0][1]
-    return factory(model_id, *args, **kwargs)
+    return factory(model_id, *args, **model_kwargs)
 
   @classmethod
-  def dir(cls):
-    return sorted(list(LanguageModel._MODEL_FACTORY.keys()))
+  def _parse_model_str(cls, model_str: str) -> tuple[str, dict[str, Any]]:
+    """Parses a model string into model ID and kwargs."""
+    parts = model_str.split('?')
+    if len(parts) == 1:
+      return model_str, {}
+    elif len(parts) == 2:
+      model_id, kwargs_str = parts
+      kwargs = {}
+      for kv in kwargs_str.split('&'):
+        kv_parts = kv.split('=')
+        if len(kv_parts) != 2:
+          raise ValueError(f'Invalid kwargs in model string: {model_str!r}.')
+        k, v = kv_parts
+        if v.isnumeric():
+          v = int(v)
+        elif v.lower() in ('true', 'false'):
+          v = v.lower() == 'true'
+        else:
+          v = v.strip()
+          try:
+            v = float(v)
+          except ValueError:
+            pass
+        kwargs[k] = v
+      return model_id, kwargs
+    else:
+      raise ValueError(f'Invalid model string: {model_str!r}.')
+
+  @classmethod
+  def dir(cls, regex: str | None = None):
+    """Returns a list of model IDs that match the given regex."""
+    if regex is None:
+      return sorted(list(LanguageModel._MODEL_FACTORY.keys()))
+    return sorted(
+        [k for k in LanguageModel._MODEL_FACTORY.keys() if re.match(regex, k)]
+    )
 
   @pg.explicit_method_override
   def __init__(self, *args, **kwargs) -> None:

langfun/core/language_model_test.py

@@ -196,6 +196,8 @@ class LanguageModelTest(unittest.TestCase):
     self.assertEqual(lm.failures_before_attempt, 1)
     self.assertEqual(lm.sampling_options.temperature, 0.2)
     self.assertIn('MockModel', lm_lib.LanguageModel.dir())
+    self.assertIn('MockModel', lm_lib.LanguageModel.dir('Mock.*'))
+    self.assertEqual(lm_lib.LanguageModel.dir('NotMock.*'), [])
 
     lm_lib.LanguageModel.register('mock://.*', mock_model)
     lm_lib.LanguageModel.register('mock.*', mock_model)
@@ -206,6 +208,26 @@ class LanguageModelTest(unittest.TestCase):
     with self.assertRaisesRegex(ValueError, 'Model not found'):
       lm_lib.LanguageModel.get('non-existent://test2')
 
+    lm = lm_lib.LanguageModel.get('MockModel?temperature=0.1')
+    self.assertEqual(lm.sampling_options.temperature, 0.1)
+
+    lm = lm_lib.LanguageModel.get(
+        'MockModel?temperature=0.1&name=my_model&logprobs=true&n=2'
+    )
+    self.assertEqual(lm.sampling_options.temperature, 0.1)
+    self.assertEqual(lm.sampling_options.n, 2)
+    self.assertTrue(lm.sampling_options.logprobs)
+    self.assertEqual(lm.name, 'my_model')
+
+    lm = lm_lib.LanguageModel.get('MockModel?temperature=0.1', temperature=0.2)
+    self.assertEqual(lm.sampling_options.temperature, 0.2)
+
+    with self.assertRaisesRegex(ValueError, 'Invalid model string'):
+      lm_lib.LanguageModel.get('MockModel??')
+
+    with self.assertRaisesRegex(ValueError, 'Invalid kwargs in model string'):
+      lm_lib.LanguageModel.get('MockModel?temperature=0.1&')
+
   def test_basics(self):
     lm = MockModel(1, temperature=0.5, top_k=2, max_attempts=2)
     self.assertEqual(

{langfun-0.1.2.dev202506240804.dist-info → langfun-0.1.2.dev202506260804.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: langfun
-Version: 0.1.2.dev202506240804
+Version: 0.1.2.dev202506260804
 Summary: Langfun: Language as Functions.
 Home-page: https://github.com/google/langfun
 Author: Langfun Authors

{langfun-0.1.2.dev202506240804.dist-info → langfun-0.1.2.dev202506260804.dist-info}/RECORD

@@ -8,8 +8,8 @@ langfun/core/console.py,sha256=cLQEf84aDxItA9fStJV22xJch0TqFLNf9hLqwJ0RHmU,2652
 langfun/core/console_test.py,sha256=pBOcuNMJdVELywvroptfcRtJMsegMm3wSlHAL2TdxVk,1679
 langfun/core/langfunc.py,sha256=G50YgoVZ0y1GFw2ev41MlOqr6qa8YakbvNC0h_E0PiA,11140
 langfun/core/langfunc_test.py,sha256=CDn-gJCa5EnjN7cotAVCfSCbuzddq2o-HzEt7kV8HbY,8882
-langfun/core/language_model.py,sha256=GCvbu749TviZyLQSNunO0rKeDAb7E_6G4rzqQJerN_E,47913
-langfun/core/language_model_test.py,sha256=iA5uo7rIj2jAtCYzMzhyNg1fWqE2Onn60bOO58q72C0,36454
+langfun/core/language_model.py,sha256=fJeYDz_TD1feiUvSysXXeo2bV-cq5T34HWeYgsTICP4,49680
+langfun/core/language_model_test.py,sha256=VyiHwrUtJGkoLyzsjhVqawijwtwoRqsYOvQD57n8Iv8,37413
 langfun/core/logging.py,sha256=7IGAhp7mGokZxxqtL-XZvFLKaZ5k3F5_Xp2NUtR4GwE,9136
 langfun/core/logging_test.py,sha256=vbVGOQxwMmVSiFfbt2897gUt-8nqDpV64jCAeUG_q5U,6924
 langfun/core/memory.py,sha256=vyXVvfvSdLLJAzdIupnbn3k26OgclCx-OJ7gddS5e1Y,2070
@@ -156,8 +156,8 @@ langfun/core/templates/demonstration.py,sha256=vCrgYubdZM5Umqcgp8NUVGXgr4P_c-fik
 langfun/core/templates/demonstration_test.py,sha256=SafcDQ0WgI7pw05EmPI2S4v1t3ABKzup8jReCljHeK4,2162
 langfun/core/templates/selfplay.py,sha256=yhgrJbiYwq47TgzThmHrDQTF4nDrTI09CWGhuQPNv-s,2273
 langfun/core/templates/selfplay_test.py,sha256=Ot__1P1M8oJfoTp-M9-PQ6HUXqZKyMwvZ5f7yQ3yfyM,2326
-langfun-0.1.2.dev202506240804.dist-info/licenses/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-langfun-0.1.2.dev202506240804.dist-info/METADATA,sha256=CbYVBGiuuboe7kzZE_6C-hfWcWEP4IjPBmbeQbyzBzU,8178
-langfun-0.1.2.dev202506240804.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-langfun-0.1.2.dev202506240804.dist-info/top_level.txt,sha256=RhlEkHxs1qtzmmtWSwYoLVJAc1YrbPtxQ52uh8Z9VvY,8
-langfun-0.1.2.dev202506240804.dist-info/RECORD,,
+langfun-0.1.2.dev202506260804.dist-info/licenses/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+langfun-0.1.2.dev202506260804.dist-info/METADATA,sha256=NQpc4kGauaQeKVVYTyt65znOYgwycKLe6K_HpBpPnok,8178
+langfun-0.1.2.dev202506260804.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+langfun-0.1.2.dev202506260804.dist-info/top_level.txt,sha256=RhlEkHxs1qtzmmtWSwYoLVJAc1YrbPtxQ52uh8Z9VvY,8
+langfun-0.1.2.dev202506260804.dist-info/RECORD,,