nirs4all.api package
Submodules
- nirs4all.api.advanced_capabilities module
AdvancedApiCapabilityDecisionAdvancedApiCapabilityDecision.contractAdvancedApiCapabilityDecision.executableAdvancedApiCapabilityDecision.laneAdvancedApiCapabilityDecision.mitigationAdvancedApiCapabilityDecision.pluginAdvancedApiCapabilityDecision.reasonAdvancedApiCapabilityDecision.requested_engineAdvancedApiCapabilityDecision.require()AdvancedApiCapabilityDecision.to_dict()AdvancedApiCapabilityDecision.unsupported_capabilityAdvancedApiCapabilityDecision.verb
advanced_api_capability_ledger()preflight_advanced_api()
- nirs4all.api.calibrate module
ConformalCalibrationDataConformalCalibrationData.datasetConformalCalibrationData.group_columnConformalCalibrationData.groupsConformalCalibrationData.include_augmentedConformalCalibrationData.metadataConformalCalibrationData.metadata_columnsConformalCalibrationData.model_bundleConformalCalibrationData.model_pathConformalCalibrationData.predictorConformalCalibrationData.predictor_bundleConformalCalibrationData.predictor_chain_idConformalCalibrationData.predictor_fingerprintConformalCalibrationData.predictor_pathConformalCalibrationData.predictor_resultConformalCalibrationData.sample_id_columnConformalCalibrationData.sample_idsConformalCalibrationData.selectorConformalCalibrationData.to_dict()ConformalCalibrationData.workspace_chain_idConformalCalibrationData.workspace_pathConformalCalibrationData.y_predConformalCalibrationData.y_true
Nirs4AllCalibrationNotImplementedErrorattach_calibrated_result_to_bundle()calibrate()conformal_metrics()export_calibrated_result()load_calibrated_result()load_workspace_calibrated_predict_result()load_workspace_calibrated_result()predict_calibrated()save_workspace_calibrated_result()
- nirs4all.api.dagml_training module
- nirs4all.api.dataset_documents module
- nirs4all.api.dataset_inspection module
- nirs4all.api.explain module
- nirs4all.api.general_explain module
- nirs4all.api.general_retrain module
- nirs4all.api.general_synthesis module
- nirs4all.api.general_transfer module
- nirs4all.api.generate module
- nirs4all.api.inspector_json module
- nirs4all.api.inspector_normalization module
- nirs4all.api.inspector_views module
BiasVarianceEntryBiasVarianceRequestBiasVarianceResponseBranchComparisonEntryBranchComparisonEntry.branch_pathBranchComparisonEntry.chain_idsBranchComparisonEntry.ci_lowerBranchComparisonEntry.ci_upperBranchComparisonEntry.countBranchComparisonEntry.labelBranchComparisonEntry.maxBranchComparisonEntry.meanBranchComparisonEntry.minBranchComparisonEntry.model_configBranchComparisonEntry.std
BranchComparisonRequestBranchComparisonResponseBranchTopologyResponseCandlestickCategoryCandlestickRequestCandlestickResponseConfusionMatrixCellConfusionMatrixRequestConfusionMatrixResponseFoldScoreEntryFoldStabilityRequestFoldStabilityResponseHeatmapCellHeatmapRequestHeatmapResponseHistogramBinHistogramResponseHyperparameterPointHyperparameterRequestHyperparameterResponseInspectorDataResponseInspectorDataResponse.available_datasetsInspectorDataResponse.available_metricsInspectorDataResponse.available_modelsInspectorDataResponse.available_preprocessingsInspectorDataResponse.available_runsInspectorDataResponse.available_targetsInspectorDataResponse.chainsInspectorDataResponse.generated_atInspectorDataResponse.model_configInspectorDataResponse.total
InspectorViewErrorPreprocessingImpactEntryPreprocessingImpactRequestPreprocessingImpactResponseRankingsResponseScatterPointScatterRequestScatterResponseScoreRefTopologyNodeget_bias_variance()get_branch_comparison()get_branch_topology()get_candlestick_data()get_confusion_matrix()get_fold_stability()get_heatmap_data()get_histogram_data()get_hyperparameter_data()get_inspector_data()get_preprocessing_impact()get_rankings_data()get_scatter_data()read_inspector_view()
- nirs4all.api.library_playground module
- nirs4all.api.native_archive_training module
NativeArchiveTrainingErrorNativeMethodsArchiveRunResultNativeMethodsArchiveRunResult.close()NativeMethodsArchiveRunResult.export()NativeMethodsArchiveRunResult.native_archive_referenceNativeMethodsArchiveRunResult.native_execution_is_liveNativeMethodsArchiveRunResult.tuning_best_paramsNativeMethodsArchiveRunResult.tuning_best_valueNativeMethodsArchiveRunResult.tuning_resume_packageNativeMethodsArchiveRunResult.tuning_scope_results
NativeMethodsHpoCapabilityErrorrun_native_methods_archive()
- nirs4all.api.native_capabilities module
- nirs4all.api.native_refit_result module
NativeMethodsRefitResultNativeMethodsRefitResult.export()NativeMethodsRefitResult.from_package_json()NativeMethodsRefitResult.load_archive()NativeMethodsRefitResult.load_package()NativeMethodsRefitResult.packageNativeMethodsRefitResult.package_json()NativeMethodsRefitResult.predict()NativeMethodsRefitResult.save_package()
- nirs4all.api.native_result module
NativeMethodsRunResultNativeMethodsRunResult.close()NativeMethodsRunResult.detach()NativeMethodsRunResult.export()NativeMethodsRunResult.export_model()NativeMethodsRunResult.from_estimator()NativeMethodsRunResult.hpo_resume_package_json()NativeMethodsRunResult.native_archive_referenceNativeMethodsRunResult.native_conformal_calibrationNativeMethodsRunResult.native_estimatorNativeMethodsRunResult.native_execution_claimNativeMethodsRunResult.native_execution_is_liveNativeMethodsRunResult.native_methods_hpo_resume_stateNativeMethodsRunResult.native_retrain_lineageNativeMethodsRunResult.native_selected_variant_idNativeMethodsRunResult.terminal_predictionNativeMethodsRunResult.terminal_receipt
- nirs4all.api.native_retrain_lineage module
NativeRetrainLineageNativeRetrainLineage.from_mapping()NativeRetrainLineage.from_source_outcome()NativeRetrainLineage.source_effective_plan_fingerprintNativeRetrainLineage.source_outcome_fingerprintNativeRetrainLineage.source_seedNativeRetrainLineage.source_selected_variant_fingerprintNativeRetrainLineage.source_selected_variant_idNativeRetrainLineage.source_training_request_fingerprintNativeRetrainLineage.to_dict()
- nirs4all.api.native_session module
NativeMethodsSessionNativeMethodsSession.calibrationNativeMethodsSession.close()NativeMethodsSession.closedNativeMethodsSession.is_trainedNativeMethodsSession.pipelineNativeMethodsSession.predict()NativeMethodsSession.random_stateNativeMethodsSession.resultNativeMethodsSession.retrain()NativeMethodsSession.run()NativeMethodsSession.save()NativeMethodsSession.tuning
- nirs4all.api.native_training module
- nirs4all.api.native_witness module
NativeMethodsExecutionClaimNativeMethodsExecutionClaim.execution_entrypointNativeMethodsExecutionClaim.execution_modeNativeMethodsExecutionClaim.methods_library_modeNativeMethodsExecutionClaim.outcome_fingerprintNativeMethodsExecutionClaim.portable_artifacts_requiredNativeMethodsExecutionClaim.schema_versionNativeMethodsExecutionClaim.to_dict()
NativeMethodsTerminalExecutionClaimNativeMethodsTerminalExecutionClaim.execution_entrypointNativeMethodsTerminalExecutionClaim.execution_modeNativeMethodsTerminalExecutionClaim.methods_library_modeNativeMethodsTerminalExecutionClaim.outcome_fingerprintNativeMethodsTerminalExecutionClaim.portable_artifacts_requiredNativeMethodsTerminalExecutionClaim.receipt_fingerprintNativeMethodsTerminalExecutionClaim.schema_versionNativeMethodsTerminalExecutionClaim.terminal_run_idNativeMethodsTerminalExecutionClaim.to_dict()
- nirs4all.api.portable_archive module
- nirs4all.api.predict module
- nirs4all.api.public_results module
- nirs4all.api.public_tuning module
- nirs4all.api.result module
- nirs4all.api.retrain module
- nirs4all.api.retrain_capabilities module
- nirs4all.api.robustness module
RobustnessMetricSetRobustnessReportRobustnessReport.degradation_rows()RobustnessReport.fingerprintRobustnessReport.from_dict()RobustnessReport.from_json()RobustnessReport.load_artifacts()RobustnessReport.load_json()RobustnessReport.load_parquet()RobustnessReport.metadataRobustnessReport.modeRobustnessReport.save_artifacts()RobustnessReport.save_html()RobustnessReport.save_json()RobustnessReport.save_markdown()RobustnessReport.save_parquet()RobustnessReport.save_summary()RobustnessReport.scenariosRobustnessReport.slice_byRobustnessReport.summary_artifact()RobustnessReport.summary_rows()RobustnessReport.tabular_records()RobustnessReport.to_dict()RobustnessReport.to_html()RobustnessReport.to_json()RobustnessReport.to_markdown()RobustnessReport.to_summary_json()RobustnessReport.versionRobustnessReport.worst_slices()
RobustnessScenarioResultRobustnessScenarioResult.conformal_metricsRobustnessScenarioResult.fingerprintRobustnessScenarioResult.from_dict()RobustnessScenarioResult.metricsRobustnessScenarioResult.scenarioRobustnessScenarioResult.severityRobustnessScenarioResult.slicesRobustnessScenarioResult.to_dict()RobustnessScenarioResult.version
RobustnessScenarioSpecRobustnessSliceResultget_robustness_summary_schema()load_workspace_robustness_report()robustness()robustness_summary_schema_json()save_workspace_robustness_report()
- nirs4all.api.run module
- nirs4all.api.run_selection module
- nirs4all.api.session module
- nirs4all.api.studio_lineage module
- nirs4all.api.studio_scientific module
- nirs4all.api.studio_scientific_general module
- nirs4all.api.tuning module
NativeTuningNativeTuning.calibrationNativeTuning.directionNativeTuning.engineNativeTuning.force_paramsNativeTuning.inspect_space()NativeTuning.metricNativeTuning.n_trialsNativeTuning.prunerNativeTuning.resumeNativeTuning.samplerNativeTuning.score_dataNativeTuning.seedNativeTuning.spaceNativeTuning.storageNativeTuning.study_nameNativeTuning.to_dict()NativeTuning.to_tuning_spec()NativeTuning.winnerNativeTuning.workspace_metadataNativeTuning.workspace_tuning_id
OrderedSearchSpaceSpecOrderedSearchSpaceSpec.fingerprintOrderedSearchSpaceSpec.from_mapping()OrderedSearchSpaceSpec.from_tuning_spec()OrderedSearchSpaceSpec.parametersOrderedSearchSpaceSpec.patch()OrderedSearchSpaceSpec.patches_from_mapping()OrderedSearchSpaceSpec.pathsOrderedSearchSpaceSpec.to_dict()OrderedSearchSpaceSpec.to_space_mapping()
ParameterPatchSearchSpaceParameterTunedSingleEstimatorConformalResultTunedSingleEstimatorConformalResult.calibratedTunedSingleEstimatorConformalResult.conformal_guarantee_statusTunedSingleEstimatorConformalResult.interval()TunedSingleEstimatorConformalResult.interval_coveragesTunedSingleEstimatorConformalResult.metrics()TunedSingleEstimatorConformalResult.robustness()TunedSingleEstimatorConformalResult.runTunedSingleEstimatorConformalResult.tuning_best_paramsTunedSingleEstimatorConformalResult.tuning_best_valueTunedSingleEstimatorConformalResult.tuning_idTunedSingleEstimatorConformalResult.tuning_result
TuningCalibrationTuningCalibration.as_predict_resultTuningCalibration.coverageTuningCalibration.extraTuningCalibration.methodTuningCalibration.prediction_sample_idsTuningCalibration.to_dict()TuningCalibration.unitTuningCalibration.workspace_conformal_idTuningCalibration.workspace_metadataTuningCalibration.y_pred
TuningConformalScoreCalibrationTuningConformalScoreCalibration.XTuningConformalScoreCalibration.X_calibrationTuningConformalScoreCalibration.calibration_groupsTuningConformalScoreCalibration.calibration_metadataTuningConformalScoreCalibration.calibration_sample_idsTuningConformalScoreCalibration.featuresTuningConformalScoreCalibration.groupsTuningConformalScoreCalibration.metadataTuningConformalScoreCalibration.physical_sample_idsTuningConformalScoreCalibration.sample_idsTuningConformalScoreCalibration.targetTuningConformalScoreCalibration.targetsTuningConformalScoreCalibration.to_dict()TuningConformalScoreCalibration.yTuningConformalScoreCalibration.y_calibrationTuningConformalScoreCalibration.y_true
TuningPassthroughTuningScoreDataTuningScoreData.XTuningScoreData.X_scoreTuningScoreData.conformal_calibrationTuningScoreData.conformal_coverageTuningScoreData.datasetTuningScoreData.group_columnTuningScoreData.groupsTuningScoreData.include_augmentedTuningScoreData.metadataTuningScoreData.metadata_columnsTuningScoreData.metricTuningScoreData.physical_sample_idsTuningScoreData.prediction_sample_idsTuningScoreData.sample_id_columnTuningScoreData.sample_idsTuningScoreData.score_groupsTuningScoreData.score_metadataTuningScoreData.score_metricTuningScoreData.score_sample_idsTuningScoreData.selectorTuningScoreData.to_dict()TuningScoreData.yTuningScoreData.y_score
TuningWinnerTuningWinner.XTuningWinner.datasetTuningWinner.dataset_nameTuningWinner.group_columnTuningWinner.include_augmentedTuningWinner.metadataTuningWinner.metadata_columnsTuningWinner.metricTuningWinner.model_nameTuningWinner.physical_sample_idsTuningWinner.prediction_sample_idsTuningWinner.sample_id_columnTuningWinner.sample_idsTuningWinner.scoreTuningWinner.selectorTuningWinner.task_typeTuningWinner.to_dict()TuningWinner.winner_sample_idsTuningWinner.y_true
get_tuning_space_schema()inspect_tuning_space()load_workspace_tuning_result()save_workspace_tuning_result()tune_single_estimator()tuning_space_schema_json()
- nirs4all.api.workspace_chain_snapshot module