🔧 refactor(config): rename model_path to custom_model_path

- Update configuration parameter name for better clarity - Modify README examples to use new parameter name - Adjust test cases and implementation to reflect parameter rename - Improve documentation and code consistency

Author: sudoskys

README.md

@@ -105,8 +105,13 @@ We provide a fallback mechanism: when `allow_fallback=True`, if the program fail
 
 ```python
 # Disable fallback - will raise error if large model fails to load
-# But fallback disabled when model_path is not None, because its a custom model
-config = LangDetectConfig(allow_fallback=False, model_path=None)
+# But fallback disabled when custom_model_path is not None, because its a custom model, we will directly use it.
+import tempfile
+config = LangDetectConfig(
+ allow_fallback=False, 
+ custom_model_path=None,
+ cache_dir=tempfile.gettempdir(),
+ )
 detector = LangDetector(config)
 
 try:
@@ -136,7 +141,7 @@ print(detect_language("你好，世界！"))
 ```python
 # Load model from local file
 config = LangDetectConfig(
- model_path="/path/to/your/model.bin", # Use local model file
+ custom_model_path="/path/to/your/model.bin", # Use local model file
  disable_verify=True # Skip MD5 verification
 )
 detector = LangDetector(config)

src/fast_langdetect/infer.py

@@ -168,7 +168,7 @@ class LangDetectConfig:
  Configuration for language detection.
 
  :param cache_dir: Directory for storing downloaded models
- :param model_path: Path to custom model file (if using own model)
+ :param custom_model_path: Path to custom model file (if using own model)
  :param proxy: HTTP proxy for downloads
  :param allow_fallback: Whether to fallback to small model
  :param disable_verify: Whether to disable MD5 verification
@@ -177,21 +177,21 @@ class LangDetectConfig:
  def __init__(
  self,
  cache_dir: Optional[str] = None,
- model_path: Optional[str] = None,
+ custom_model_path: Optional[str] = None,
  proxy: Optional[str] = None,
  allow_fallback: bool = True,
  disable_verify: bool = False,
  verify_hash: Optional[str] = None,
  ):
  self.cache_dir = cache_dir or CACHE_DIRECTORY
- self.model_path = model_path
+ self.custom_model_path = custom_model_path
  self.proxy = proxy
  self.allow_fallback = allow_fallback
  # Only verify large model
  self.disable_verify = disable_verify
  self.verify_hash = verify_hash
- if self.model_path and not Path(self.model_path).exists():
- raise FileNotFoundError(f"fast-langdetect: Target model file not found: {self.model_path}")
+ if self.custom_model_path and not Path(self.custom_model_path).exists():
+ raise FileNotFoundError(f"fast-langdetect: Target model file not found: {self.custom_model_path}")
 
 class LangDetector:
  """Language detector using FastText models."""
@@ -214,11 +214,11 @@ def _get_model(self, low_memory: bool = True) -> Any:
  return model
 
  try:
- if self.config.model_path is not None:
+ if self.config.custom_model_path is not None:
  # Load Custom Model
  if self.config.disable_verify:
  self.config.verify_hash = None
- model = self._model_loader.load_local(Path(self.config.model_path))
+ model = self._model_loader.load_local(Path(self.config.custom_model_path))
  elif low_memory is True:
  self.config.verify_hash = None
  # Load Small Model

tests/test_real_detection.py

@@ -87,7 +87,7 @@ def test_not_found_model(self):
  with pytest.raises(FileNotFoundError):
  config = LangDetectConfig(
  cache_dir="/nonexistent/path",
- model_path="invalid_path",
+ custom_model_path="invalid_path",
  allow_fallback=True,
  )
  detector = LangDetector(config)