Function init

python/zvec/zvec.py:29–184

Initialize Zvec with configuration options. This function must be called before any other operation. It can only be called once — subsequent calls raise a ``RuntimeError``. Parameters set to ``None`` are **omitted** from the configuration and fall back to Zvec's internal defaults,

(
    *,
    log_type: Optional[LogType] = None,
    log_level: Optional[LogLevel] = None,
    log_dir: Optional[str] = "./logs",
    log_basename: Optional[str] = "zvec.log",
    log_file_size: Optional[int] = 2048,
    log_overdue_days: Optional[int] = 7,
    query_threads: Optional[int] = None,
    optimize_threads: Optional[int] = None,
    invert_to_forward_scan_ratio: Optional[float] = None,
    brute_force_by_keys_ratio: Optional[float] = None,
    fts_brute_force_by_keys_ratio: Optional[float] = None,
    memory_limit_mb: Optional[int] = None,
    jieba_dict_dir: Optional[str] = None,
)

def init(
    *,
    log_type: Optional[LogType] = None,
    log_level: Optional[LogLevel] = None,
    log_dir: Optional[str] = "./logs",
    log_basename: Optional[str] = "zvec.log",
    log_file_size: Optional[int] = 2048,
    log_overdue_days: Optional[int] = 7,
    query_threads: Optional[int] = None,
    optimize_threads: Optional[int] = None,
    invert_to_forward_scan_ratio: Optional[float] = None,
    brute_force_by_keys_ratio: Optional[float] = None,
    fts_brute_force_by_keys_ratio: Optional[float] = None,
    memory_limit_mb: Optional[int] = None,
    jieba_dict_dir: Optional[str] = None,
) -> None:
    """Initialize Zvec with configuration options.

    This function must be called before any other operation.
    It can only be called once — subsequent calls raise a ``RuntimeError``.

    Parameters set to ``None`` are **omitted** from the configuration and
    fall back to Zvec's internal defaults, which may be derived from the runtime
    environment (e.g., cgroup CPU/memory limits). Explicitly provided values
    always override defaults.

    Args:
        log_type (Optional[LogType], optional): Logger destination.
            - ``LogType.CONSOLE`` (default if omitted or set to this)
            - ``LogType.FILE``
            - If ``None``, uses internal default (currently ``CONSOLE``).
        log_level (Optional[LogLevel], optional): Minimum log severity.
            Default: ``LogLevel.WARN``.
            Accepted values: ``DEBUG``, ``INFO``, ``WARN``, ``ERROR``, ``FATAL``.
            If ``None``, uses internal default (``WARN``).
        log_dir (Optional[str], optional):
            Directory for log files (only used when ``log_type=FILE``).
            Parent directories are **not** created automatically.
            Default: ``"./logs"``.
            If ``None``, internal default is used.
        log_basename (Optional[str], optional):
            Base name for rotated log files (e.g., ``zvec.log.1``, ``zvec.log.2``).
            Default: ``"zvec.log"``.
        log_file_size (Optional[int], optional):
            Max size per log file in **MB** before rotation.
            Default: ``2048`` MB (2 GB).
        log_overdue_days (Optional[int], optional):
            Days to retain rotated log files before deletion.
            Default: ``7`` days.
        query_threads (Optional[int], optional):
            Number of threads for query execution.
            If ``None`` (default), inferred from available CPU cores (via cgroup).
            Must be ≥ 1 if provided.
        optimize_threads (Optional[int], optional):
            Threads for background tasks (e.g., compaction, indexing).
            If ``None`` (default), uses the same environment-aware default as
            ``query_threads``.
        invert_to_forward_scan_ratio (Optional[float], optional):