nirs4all.core package

Subpackages

• nirs4all.core.logging package
  • Submodules
    • nirs4all.core.logging.config module
      • LogConfig
      • Nirs4allLogger
      • configure_logging()
      • get_config()
      • get_logger()
      • is_configured()
      • reset_logging()
    • nirs4all.core.logging.context module
      • BranchContext
      • LogContext
      • RunState
      • SourceContext
      • StackContext
      • get_current_state()
      • get_run_id()
      • inject_context()
    • nirs4all.core.logging.events module
      • EventType
      • LogEvent
      • Phase
      • Status
    • nirs4all.core.logging.formatters module
      • ConsoleFormatter
      • FileFormatter
      • JsonFormatter
      • Symbols
      • configure_symbols()
      • format_duration()
      • format_number()
      • format_run_footer()
      • format_run_header()
      • format_table()
      • get_symbols()
    • nirs4all.core.logging.handlers module
      • BufferedHandler
      • NullHandler
      • RotatingRunFileHandler
      • ThrottledHandler
    • nirs4all.core.logging.progress module
      • EvaluationProgress
      • MultiLevelProgress
      • ProgressBar
      • ProgressConfig
      • SpinnerProgress
      • configure_progress()
      • evaluation_progress()
      • progress_bar()
      • spinner()
  • Module contents
    • BranchContext
      • BranchContext.name
      • BranchContext.path
      • BranchContext.index
      • BranchContext.total
      • BranchContext.parent
      • BranchContext.depth
      • BranchContext.depth
      • BranchContext.index
      • BranchContext.name
      • BranchContext.parent
      • BranchContext.path
      • BranchContext.total
    • BufferedHandler
      • BufferedHandler.clear()
      • BufferedHandler.emit()
      • BufferedHandler.flush_to()
      • BufferedHandler.get_records()
    • ConsoleFormatter
      • ConsoleFormatter.COLORS
      • ConsoleFormatter.LEVEL_COLORS
      • ConsoleFormatter.format()
      • ConsoleFormatter.set_run_start()
    • EvaluationProgress
      • EvaluationProgress.__enter__()
      • EvaluationProgress.__exit__()
      • EvaluationProgress.best_pipeline
      • EvaluationProgress.best_score
      • EvaluationProgress.update()
    • EventType
      • EventType.ARTIFACT
      • EventType.BRANCH_COMPARE
      • EventType.BRANCH_ENTER
      • EventType.BRANCH_EXIT
      • EventType.BUILD
      • EventType.COLLECT
      • EventType.COMPLETE
      • EventType.CONFIG_LOAD
      • EventType.DEDUPLICATE
      • EventType.ENVIRONMENT
      • EventType.ERROR
      • EventType.EXPAND
      • EventType.LEAKAGE_CHECK
      • EventType.LOAD
      • EventType.METRIC
      • EventType.MODEL
      • EventType.PREDICTIONS
      • EventType.PROGRESS
      • EventType.PRUNE
      • EventType.REPORT
      • EventType.SKIP
      • EventType.SOURCE_CONCAT
      • EventType.SOURCE_PROCESS
      • EventType.START
      • EventType.STEP
      • EventType.TRAIN_META
      • EventType.TRANSFORM
      • EventType.VALIDATE
      • EventType.WARNING
    • FileFormatter
      • FileFormatter.format()
    • JsonFormatter
      • JsonFormatter.format()
      • JsonFormatter.set_run_id()
    • LogContext
      • LogContext.__enter__()
      • LogContext.__exit__()
      • LogContext.branch()
      • LogContext.phase()
      • LogContext.source()
      • LogContext.stack()
    • LogEvent
      • LogEvent.timestamp
      • LogEvent.level
      • LogEvent.phase
      • LogEvent.event_type
      • LogEvent.message
      • LogEvent.run_id
      • LogEvent.status
      • LogEvent.branch_name
      • LogEvent.branch_path
      • LogEvent.branch_index
      • LogEvent.source_index
      • LogEvent.source_name
      • LogEvent.duration_ms
      • LogEvent.metrics
      • LogEvent.extra
      • LogEvent.branch_index
      • LogEvent.branch_name
      • LogEvent.branch_path
      • LogEvent.duration_ms
      • LogEvent.event_type
      • LogEvent.extra
      • LogEvent.level
      • LogEvent.message
      • LogEvent.metrics
      • LogEvent.phase
      • LogEvent.run_id
      • LogEvent.source_index
      • LogEvent.source_name
      • LogEvent.status
      • LogEvent.timestamp
      • LogEvent.to_dict()
      • LogEvent.to_json()
    • MultiLevelProgress
      • MultiLevelProgress.close_all()
      • MultiLevelProgress.fold_level()
      • MultiLevelProgress.pipeline_level()
      • MultiLevelProgress.run_level()
      • MultiLevelProgress.training_level()
    • Nirs4allLogger
      • Nirs4allLogger.artifact()
      • Nirs4allLogger.makeRecord()
      • Nirs4allLogger.metric()
      • Nirs4allLogger.phase_complete()
      • Nirs4allLogger.phase_start()
      • Nirs4allLogger.progress()
      • Nirs4allLogger.run_footer()
      • Nirs4allLogger.run_header()
      • Nirs4allLogger.starting()
      • Nirs4allLogger.success()
      • Nirs4allLogger.trace()
    • NullHandler
      • NullHandler.emit()
    • Phase
      • Phase.BRANCH
      • Phase.COMPLETE
      • Phase.DATA
      • Phase.EVALUATE
      • Phase.EXPORT
      • Phase.GENERATE
      • Phase.INIT
      • Phase.PREDICT
      • Phase.SOURCE
      • Phase.SPLIT
      • Phase.STACK
      • Phase.TRAIN
    • ProgressBar
      • ProgressBar.COLOR_CYAN
      • ProgressBar.COLOR_DIM
      • ProgressBar.COLOR_GREEN
      • ProgressBar.COLOR_RESET
      • ProgressBar.COLOR_YELLOW
      • ProgressBar.EMPTY_ASCII
      • ProgressBar.EMPTY_UNICODE
      • ProgressBar.FILLED_ASCII
      • ProgressBar.FILLED_UNICODE
      • ProgressBar.__enter__()
      • ProgressBar.__exit__()
      • ProgressBar.close()
      • ProgressBar.set_description()
      • ProgressBar.set_postfix()
      • ProgressBar.start()
      • ProgressBar.update()
      • ProgressBar.wrap()
    • ProgressConfig
      • ProgressConfig.bar_width
      • ProgressConfig.show_percentage
      • ProgressConfig.show_count
      • ProgressConfig.show_elapsed
      • ProgressConfig.show_eta
      • ProgressConfig.show_rate
      • ProgressConfig.refresh_rate
      • ProgressConfig.use_unicode
      • ProgressConfig.use_colors
      • ProgressConfig.bar_width
      • ProgressConfig.refresh_rate
      • ProgressConfig.show_count
      • ProgressConfig.show_elapsed
      • ProgressConfig.show_eta
      • ProgressConfig.show_percentage
      • ProgressConfig.show_rate
      • ProgressConfig.use_colors
      • ProgressConfig.use_unicode
    • RotatingRunFileHandler
      • RotatingRunFileHandler.close()
      • RotatingRunFileHandler.emit()
      • RotatingRunFileHandler.get_json_file_path()
      • RotatingRunFileHandler.get_log_file_path()
    • RunState
      • RunState.run_id
      • RunState.run_name
      • RunState.project
      • RunState.start_time
      • RunState.current_phase
      • RunState.branch_stack
      • RunState.source_context
      • RunState.stack_context
      • RunState.extra
      • RunState.branch_depth
      • RunState.branch_path
      • RunState.branch_stack
      • RunState.current_branch
      • RunState.current_phase
      • RunState.extra
      • RunState.project
      • RunState.run_id
      • RunState.run_name
      • RunState.source_context
      • RunState.stack_context
      • RunState.start_time
    • SourceContext
      • SourceContext.name
      • SourceContext.index
      • SourceContext.total
      • SourceContext.index
      • SourceContext.name
      • SourceContext.total
    • SpinnerProgress
      • SpinnerProgress.FRAMES_ASCII
      • SpinnerProgress.FRAMES_UNICODE
      • SpinnerProgress.__enter__()
      • SpinnerProgress.__exit__()
      • SpinnerProgress.start()
      • SpinnerProgress.stop()
      • SpinnerProgress.update()
    • StackContext
      • StackContext.n_branches
      • StackContext.meta_model
      • StackContext.branch_sources
      • StackContext.branch_sources
      • StackContext.meta_model
      • StackContext.n_branches
    • Status
      • Status.ERROR
      • Status.IN_PROGRESS
      • Status.SKIPPED
      • Status.STARTING
      • Status.SUCCESS
      • Status.WARNING
    • Symbols
      • Symbols.arrow
      • Symbols.branch
      • Symbols.branch_item
      • Symbols.error
      • Symbols.get_status_symbol()
      • Symbols.indent
      • Symbols.progress
      • Symbols.separator_heavy
      • Symbols.separator_light
      • Symbols.skipped
      • Symbols.starting
      • Symbols.sub_item
      • Symbols.success
      • Symbols.warning
    • ThrottledHandler
      • ThrottledHandler.MILESTONES
      • ThrottledHandler.close()
      • ThrottledHandler.emit()
      • ThrottledHandler.reset()
    • configure_logging()
    • configure_progress()
    • evaluation_progress()
    • format_duration()
    • format_number()
    • format_run_footer()
    • format_run_header()
    • format_table()
    • get_config()
    • get_current_state()
    • get_logger()
    • get_run_id()
    • get_symbols()
    • is_configured()
    • progress_bar()
    • reset_logging()
    • spinner()

Submodules

• nirs4all.core.config module
• nirs4all.core.exceptions module
• nirs4all.core.metrics module
  • abbreviate_metric()
  • eval()
  • eval_list()
  • eval_multi()
  • get_available_metrics()
  • get_default_metrics()
  • get_stats()
• nirs4all.core.task_detection module
  • detect_task_type()
• nirs4all.core.task_type module
  • TaskType
    • TaskType.BINARY_CLASSIFICATION
    • TaskType.MULTICLASS_CLASSIFICATION
    • TaskType.REGRESSION
    • TaskType.is_classification
    • TaskType.is_regression
• nirs4all.core.validation module

Module contents

Core functionality for nirs4all.

This module contains fundamental types, metrics, and task detection logic that are used throughout the library.

class nirs4all.core.TaskType(value)

Bases: str, Enum

Enumeration of machine learning task types.

BINARY_CLASSIFICATION = 'binary_classification'

MULTICLASS_CLASSIFICATION = 'multiclass_classification'

REGRESSION = 'regression'

property is_classification: bool

Check if this is a classification task.

property is_regression: bool

Check if this is a regression task.

nirs4all.core.detect_task_type(y: ndarray, threshold: float = 0.05) → TaskType

Detect task type based on target values.

Parameters:

• y – Target values array

• threshold – Threshold for determining if values are continuous (regression) vs discrete (classification). For integer values, if n_unique <= max_classes or n_unique <= len(y) * threshold, it’s considered classification.

Returns:

Detected task type

Return type:

TaskType