powermean 0.1.0a1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- powermean/__init__.py +93 -0
- powermean/_native/__init__.py +5 -0
- powermean/_native/basis/__init__.py +14 -0
- powermean/_native/iols/__init__.py +5 -0
- powermean/_prepare/__init__.py +14 -0
- powermean/_prepare/compose.py +337 -0
- powermean/_prepare/dependence.py +498 -0
- powermean/_prepare/effects.py +129 -0
- powermean/_prepare/inputs.py +171 -0
- powermean/_prepare/owned.py +151 -0
- powermean/_vendor/SKLEARN_COPYING +319 -0
- powermean/_vendor/__init__.py +16 -0
- powermean/_vendor/_compat.py +192 -0
- powermean/_vendor/_scipy.py +98 -0
- powermean/_vendor/_typing.py +143 -0
- powermean/_vendor/vendor_linear_loss.py +877 -0
- powermean/_vendor/vendor_newton.py +737 -0
- powermean/api.py +408 -0
- powermean/data/__init__.py +12 -0
- powermean/data/_arrays.py +52 -0
- powermean/data/accounting.py +146 -0
- powermean/data/collinearity.py +344 -0
- powermean/data/collinearity_geometry.py +441 -0
- powermean/data/collinearity_numeric.py +423 -0
- powermean/data/collinearity_records.py +433 -0
- powermean/data/computation.py +179 -0
- powermean/data/design.py +203 -0
- powermean/data/fe_component_storage.py +366 -0
- powermean/data/fingerprint.py +183 -0
- powermean/data/inference_conventions.py +175 -0
- powermean/data/inference_requests.py +350 -0
- powermean/data/inputs.py +239 -0
- powermean/data/numeric_fit.py +165 -0
- powermean/data/raw.py +675 -0
- powermean/data/request_values.py +196 -0
- powermean/data/retained.py +450 -0
- powermean/data/sample.py +291 -0
- powermean/data/sample_fe.py +530 -0
- powermean/data/sample_fe_source.py +562 -0
- powermean/data/sample_fe_state.py +582 -0
- powermean/data/specs.py +515 -0
- powermean/data/weights.py +196 -0
- powermean/effects/__init__.py +5 -0
- powermean/effects/targets.py +249 -0
- powermean/errors.py +229 -0
- powermean/fe/__init__.py +17 -0
- powermean/fe/_cancel_storage.py +102 -0
- powermean/fe/absorb.py +512 -0
- powermean/fe/absorb_acceleration.py +554 -0
- powermean/fe/absorb_numeric.py +717 -0
- powermean/fe/admission.py +240 -0
- powermean/fe/admission_budget.py +75 -0
- powermean/fe/admission_incidence.py +137 -0
- powermean/fe/admission_records.py +124 -0
- powermean/fe/admission_slopes.py +163 -0
- powermean/fe/cancel.py +214 -0
- powermean/fe/certificate_basis.py +3246 -0
- powermean/fe/certificate_coordinates.py +504 -0
- powermean/fe/certificate_witness.py +426 -0
- powermean/fe/connectivity.py +348 -0
- powermean/fe/geometry.py +261 -0
- powermean/fe/geometry_checks.py +214 -0
- powermean/fe/geometry_design.py +314 -0
- powermean/fe/geometry_eigh.py +44 -0
- powermean/fe/geometry_errors.py +67 -0
- powermean/fe/geometry_gram.py +309 -0
- powermean/fe/geometry_rank.py +392 -0
- powermean/fe/geometry_storage.py +35 -0
- powermean/fe/groups.py +556 -0
- powermean/fe/primitive_codes.py +189 -0
- powermean/fe/profile.py +605 -0
- powermean/fe/profile_arithmetic.py +970 -0
- powermean/fe/profile_nb2.py +521 -0
- powermean/fe/profile_nb2_scalar.py +480 -0
- powermean/fe/reductions.py +356 -0
- powermean/fe/retained.py +147 -0
- powermean/formula/__init__.py +11 -0
- powermean/formula/formulaic_api.py +234 -0
- powermean/formula/frame.py +299 -0
- powermean/formula/grammar.py +236 -0
- powermean/formula/materialization.py +182 -0
- powermean/formula/names.py +271 -0
- powermean/formula/validity.py +104 -0
- powermean/inference/__init__.py +12 -0
- powermean/inference/absorbed.py +201 -0
- powermean/inference/absorbed_adjusted.py +133 -0
- powermean/inference/absorbed_code_tuples.py +60 -0
- powermean/inference/absorbed_composition.py +176 -0
- powermean/inference/absorbed_constant.py +201 -0
- powermean/inference/absorbed_details.py +92 -0
- powermean/inference/absorbed_hc_scale.py +102 -0
- powermean/inference/absorbed_preflight.py +378 -0
- powermean/inference/absorbed_rank.py +390 -0
- powermean/inference/absorbed_rows.py +23 -0
- powermean/inference/absorbed_warnings.py +39 -0
- powermean/inference/bread.py +214 -0
- powermean/inference/cancelled.py +174 -0
- powermean/inference/coefficient_combinations.py +304 -0
- powermean/inference/coefficient_expressions.py +230 -0
- powermean/inference/contributions.py +282 -0
- powermean/inference/convention.py +360 -0
- powermean/inference/correction/__init__.py +5 -0
- powermean/inference/correction/_cancelled_operator.py +178 -0
- powermean/inference/correction/_inputs.py +141 -0
- powermean/inference/correction/_row_derivatives.py +178 -0
- powermean/inference/correction/budget.py +167 -0
- powermean/inference/correction/cell.py +253 -0
- powermean/inference/correction/operator.py +267 -0
- powermean/inference/correction/pairs.py +137 -0
- powermean/inference/correction/selector.py +348 -0
- powermean/inference/correction/short_group.py +299 -0
- powermean/inference/hc.py +1239 -0
- powermean/inference/hc_provider.py +251 -0
- powermean/inference/influence.py +185 -0
- powermean/inference/leverage.py +791 -0
- powermean/inference/linear_provider.py +172 -0
- powermean/inference/multiway.py +367 -0
- powermean/inference/numeric.py +112 -0
- powermean/inference/provider.py +174 -0
- powermean/inference/psd.py +564 -0
- powermean/inference/restriction_rank.py +195 -0
- powermean/inference/ssc.py +818 -0
- powermean/inference/vcov.py +469 -0
- powermean/inference/wz_absorbed.py +122 -0
- powermean/inference/wz_binding.py +312 -0
- powermean/inference/wz_coefficient.py +183 -0
- powermean/inference/wz_covariance.py +263 -0
- powermean/inference/wz_operator.py +374 -0
- powermean/inference/wz_resources.py +39 -0
- powermean/interface/__init__.py +17 -0
- powermean/interface/cancelled_fit.py +497 -0
- powermean/interface/cancelled_selection.py +368 -0
- powermean/interface/cancelled_tau1_origin.py +138 -0
- powermean/interface/dispatch.py +489 -0
- powermean/interface/expressions.py +197 -0
- powermean/interface/fe_bias.py +456 -0
- powermean/interface/fe_bias_options.py +30 -0
- powermean/interface/fe_cancelled_result.py +579 -0
- powermean/interface/fe_dispatch.py +1059 -0
- powermean/interface/fe_joint_result.py +751 -0
- powermean/interface/fe_options.py +452 -0
- powermean/interface/fe_result_backends.py +446 -0
- powermean/interface/fe_root.py +191 -0
- powermean/interface/numeric_execution.py +489 -0
- powermean/interface/options.py +1431 -0
- powermean/interface/owned_fit_state.py +306 -0
- powermean/interface/ppml_audit.py +1099 -0
- powermean/interface/preparation.py +416 -0
- powermean/interface/retained_admission.py +483 -0
- powermean/interface/retained_binding.py +515 -0
- powermean/interface/retained_context.py +760 -0
- powermean/interface/retained_covariance.py +204 -0
- powermean/interface/retained_metadata.py +482 -0
- powermean/interface/retained_outcomes.py +371 -0
- powermean/interface/retained_postfit.py +237 -0
- powermean/interface/retained_preparation.py +280 -0
- powermean/interface/retained_result.py +266 -0
- powermean/interface/retained_space.py +396 -0
- powermean/interface/retained_time.py +393 -0
- powermean/interface/retained_traces.py +295 -0
- powermean/interface/retention.py +313 -0
- powermean/interface/sample.py +749 -0
- powermean/interface/sample_encoding.py +57 -0
- powermean/interface/sample_evidence.py +357 -0
- powermean/interface/sample_records.py +834 -0
- powermean/messages.py +386 -0
- powermean/model/__init__.py +4 -0
- powermean/model/order.py +331 -0
- powermean/model/order_scale.py +413 -0
- powermean/model/rows.py +514 -0
- powermean/model/variance.py +231 -0
- powermean/py.typed +0 -0
- powermean/results/__init__.py +28 -0
- powermean/results/absorbed_assessment_binding.py +237 -0
- powermean/results/absorbed_assessment_capture.py +466 -0
- powermean/results/absorbed_assessment_handoff.py +441 -0
- powermean/results/absorbed_attempts.py +390 -0
- powermean/results/absorbed_binding.py +578 -0
- powermean/results/absorbed_checks.py +297 -0
- powermean/results/absorbed_geometry.py +332 -0
- powermean/results/absorbed_geometry_records.py +449 -0
- powermean/results/absorbed_groupings.py +521 -0
- powermean/results/absorbed_handoff.py +528 -0
- powermean/results/absorbed_history.py +432 -0
- powermean/results/absorbed_linear_history.py +220 -0
- powermean/results/absorbed_outcome_records.py +375 -0
- powermean/results/absorbed_owned.py +536 -0
- powermean/results/absorbed_partitions.py +565 -0
- powermean/results/absorbed_point_records.py +273 -0
- powermean/results/absorbed_points.py +409 -0
- powermean/results/absorbed_retained.py +409 -0
- powermean/results/absorbed_root.py +235 -0
- powermean/results/absorbed_root_binding.py +166 -0
- powermean/results/absorbed_root_records.py +198 -0
- powermean/results/absorbed_sample.py +702 -0
- powermean/results/absorbed_sample_binding.py +778 -0
- powermean/results/absorbed_scale_cache.py +315 -0
- powermean/results/absorbed_state_records.py +393 -0
- powermean/results/absorbed_states.py +391 -0
- powermean/results/absorbed_trace.py +351 -0
- powermean/results/active_covariance.py +241 -0
- powermean/results/binding.py +292 -0
- powermean/results/cancelled_bias.py +71 -0
- powermean/results/cancelled_inference.py +191 -0
- powermean/results/cancelled_provenance.py +129 -0
- powermean/results/cancelled_recovery.py +216 -0
- powermean/results/cancelled_retained.py +405 -0
- powermean/results/citations.py +101 -0
- powermean/results/cluster_covariance.py +369 -0
- powermean/results/contrast_reporting.py +214 -0
- powermean/results/covariance.py +657 -0
- powermean/results/effect_design.py +198 -0
- powermean/results/effect_reporting.py +305 -0
- powermean/results/fe_helpers.py +161 -0
- powermean/results/fe_result_backends.py +93 -0
- powermean/results/fe_sample.py +337 -0
- powermean/results/handoff.py +1438 -0
- powermean/results/naming.py +139 -0
- powermean/results/numeric_assessment.py +98 -0
- powermean/results/owned.py +520 -0
- powermean/results/point.py +365 -0
- powermean/results/ppml_residualized_inference.py +931 -0
- powermean/results/ppml_residualized_map.py +208 -0
- powermean/results/ppml_standard_assessment.py +694 -0
- powermean/results/ppml_standard_inference.py +348 -0
- powermean/results/ppml_standard_records.py +941 -0
- powermean/results/ppml_standard_retained.py +834 -0
- powermean/results/prediction.py +208 -0
- powermean/results/primitive_compact.py +230 -0
- powermean/results/primitive_parts.py +155 -0
- powermean/results/primitive_sample_check.py +432 -0
- powermean/results/primitive_snapshot.py +1371 -0
- powermean/results/provenance.py +572 -0
- powermean/results/restriction_reporting.py +239 -0
- powermean/results/result.py +887 -0
- powermean/results/retained.py +350 -0
- powermean/results/retained_collinearity.py +214 -0
- powermean/results/retained_collinearity_geometry.py +275 -0
- powermean/results/retained_diagnostic_problems.py +372 -0
- powermean/results/retained_gamma.py +262 -0
- powermean/results/retained_gamma_witnesses.py +394 -0
- powermean/results/retained_hc.py +649 -0
- powermean/results/retained_hc_records.py +405 -0
- powermean/results/retained_index_values.py +78 -0
- powermean/results/retained_inference.py +1571 -0
- powermean/results/retained_input_values.py +531 -0
- powermean/results/retained_inputs.py +222 -0
- powermean/results/retained_labels.py +526 -0
- powermean/results/retained_rectifier.py +364 -0
- powermean/results/retained_support.py +371 -0
- powermean/results/retained_support_lp.py +200 -0
- powermean/results/retained_support_witnesses.py +341 -0
- powermean/results/sample.py +180 -0
- powermean/results/summary.py +329 -0
- powermean/results/wz_bias.py +93 -0
- powermean/results/wz_inference.py +186 -0
- powermean/solve/__init__.py +5 -0
- powermean/solve/absorbed.py +214 -0
- powermean/solve/absorbed_certificate.py +668 -0
- powermean/solve/absorbed_certificate_block.py +521 -0
- powermean/solve/absorbed_certificate_factor.py +389 -0
- powermean/solve/absorbed_certificate_final.py +360 -0
- powermean/solve/absorbed_certificate_final_parts.py +138 -0
- powermean/solve/absorbed_certificate_geometry.py +714 -0
- powermean/solve/absorbed_certificate_history.py +645 -0
- powermean/solve/absorbed_certificate_inner.py +440 -0
- powermean/solve/absorbed_certificate_point.py +629 -0
- powermean/solve/absorbed_certificate_scale.py +312 -0
- powermean/solve/absorbed_certificate_sparse.py +340 -0
- powermean/solve/absorbed_dense_factor.py +319 -0
- powermean/solve/absorbed_direction.py +987 -0
- powermean/solve/absorbed_loss.py +922 -0
- powermean/solve/absorbed_pair_layout.py +79 -0
- powermean/solve/absorbed_rhs.py +1037 -0
- powermean/solve/absorbed_root.py +944 -0
- powermean/solve/absorbed_root_records.py +438 -0
- powermean/solve/absorbed_scale_admission.py +452 -0
- powermean/solve/absorbed_scale_details.py +124 -0
- powermean/solve/absorbed_scale_records.py +188 -0
- powermean/solve/absorbed_scale_request.py +285 -0
- powermean/solve/absorbed_start.py +477 -0
- powermean/solve/assessment.py +183 -0
- powermean/solve/cancelled_attempt.py +72 -0
- powermean/solve/cancelled_certificate.py +404 -0
- powermean/solve/cancelled_loss.py +198 -0
- powermean/solve/cancelled_operator.py +293 -0
- powermean/solve/cancelled_records.py +418 -0
- powermean/solve/cancelled_root.py +308 -0
- powermean/solve/cancelled_root_attempt.py +111 -0
- powermean/solve/cancelled_tau1.py +317 -0
- powermean/solve/cancelled_tau1_bridge.py +240 -0
- powermean/solve/certificate.py +616 -0
- powermean/solve/compact_assembly.py +456 -0
- powermean/solve/compact_matrix.py +199 -0
- powermean/solve/compact_scaling.py +249 -0
- powermean/solve/factorization.py +277 -0
- powermean/solve/iols/__init__.py +101 -0
- powermean/solve/iols/_numeric.py +29 -0
- powermean/solve/iols/adapter.py +371 -0
- powermean/solve/iols/candidate.py +290 -0
- powermean/solve/iols/direct_route.py +451 -0
- powermean/solve/iols/fe.py +287 -0
- powermean/solve/iols/kernel.py +405 -0
- powermean/solve/iols/kernel_attempt.py +388 -0
- powermean/solve/iols/kernel_grid.py +401 -0
- powermean/solve/iols/kernel_loop.py +363 -0
- powermean/solve/iols/kernel_phase.py +411 -0
- powermean/solve/iols/kernel_records.py +362 -0
- powermean/solve/iols/kernel_state.py +333 -0
- powermean/solve/iols/kernel_step.py +321 -0
- powermean/solve/iols/normalization.py +146 -0
- powermean/solve/iols/options.py +309 -0
- powermean/solve/iols/records.py +33 -0
- powermean/solve/iols/reference.py +61 -0
- powermean/solve/iols/source.py +75 -0
- powermean/solve/joint_root.py +614 -0
- powermean/solve/joint_root_records.py +203 -0
- powermean/solve/line_search.py +197 -0
- powermean/solve/linear.py +387 -0
- powermean/solve/linear_absorbed.py +338 -0
- powermean/solve/linear_absorbed_numeric.py +361 -0
- powermean/solve/linear_absorbed_point.py +380 -0
- powermean/solve/linear_absorbed_state.py +378 -0
- powermean/solve/linear_certificate.py +354 -0
- powermean/solve/linear_evaluation.py +223 -0
- powermean/solve/linear_status.py +174 -0
- powermean/solve/newton_absorbed.py +1075 -0
- powermean/solve/newton_convex.py +975 -0
- powermean/solve/newton_profiled.py +641 -0
- powermean/solve/newton_retry.py +139 -0
- powermean/solve/newton_trace.py +211 -0
- powermean/solve/no_point.py +59 -0
- powermean/solve/options.py +354 -0
- powermean/solve/point_loss.py +285 -0
- powermean/solve/profiled_indications.py +169 -0
- powermean/solve/profiled_linear_loss.py +442 -0
- powermean/solve/profiled_loss.py +725 -0
- powermean/solve/profiled_trigger.py +508 -0
- powermean/solve/quantities.py +140 -0
- powermean/solve/reduced_execution.py +625 -0
- powermean/solve/reduced_nonlinear.py +382 -0
- powermean/solve/reduced_nonlinear_loss.py +302 -0
- powermean/solve/reported.py +334 -0
- powermean/solve/root_kernel.py +448 -0
- powermean/solve/sparse_matrix.py +29 -0
- powermean/solve/starts.py +174 -0
- powermean/solve/status.py +168 -0
- powermean/solve/support.py +367 -0
- powermean/solve/support_gamma.py +550 -0
- powermean/solve/support_gamma_lp.py +579 -0
- powermean/solve/support_gamma_problem.py +208 -0
- powermean/solve/support_gamma_witness.py +507 -0
- powermean/solve/support_lp.py +451 -0
- powermean/solve/support_problem.py +220 -0
- powermean/solve/support_projection.py +582 -0
- powermean/solve/support_rectifier.py +355 -0
- powermean/solve/support_witness.py +484 -0
- powermean/solve/threads.py +2745 -0
- powermean/systems/__init__.py +5 -0
- powermean/systems/_cancel_rows.py +128 -0
- powermean/systems/admitted.py +133 -0
- powermean/systems/cancelled.py +421 -0
- powermean/systems/identified.py +184 -0
- powermean/systems/joint.py +425 -0
- powermean/systems/profiled.py +588 -0
- powermean/testing/__init__.py +53 -0
- powermean/testing/designs_solver.py +322 -0
- powermean/testing/designs_threeway.py +252 -0
- powermean/testing/designs_twoway.py +246 -0
- powermean/testing/showcase.py +371 -0
- powermean/testing/synthetic.py +272 -0
- powermean-0.1.0a1.dist-info/METADATA +151 -0
- powermean-0.1.0a1.dist-info/RECORD +376 -0
- powermean-0.1.0a1.dist-info/WHEEL +4 -0
- powermean-0.1.0a1.dist-info/licenses/LICENSE +28 -0
- powermean-0.1.0a1.dist-info/licenses/src/powermean/_vendor/SKLEARN_COPYING +319 -0
powermean/__init__.py
ADDED
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
"""powermean: power-mean regression for outcomes with zeros.
|
|
2
|
+
|
|
3
|
+
The public interface is the list ``__all__`` below: the functions ``fit``, ``ppml``,
|
|
4
|
+
``gpml``, ``logols``, ``prepare``, ``solver_defaults`` and the convention factory
|
|
5
|
+
``ssc``, the working variance ``NB2``, the typed record ``SolverOptions`` that
|
|
6
|
+
``solver_defaults`` returns, and the exceptions and warnings of the package, which a
|
|
7
|
+
caller catches or filters by these names.
|
|
8
|
+
:mod:`powermean.testing` is the synthetic data used by tests, examples and fixtures,
|
|
9
|
+
with its own ``__all__``.
|
|
10
|
+
|
|
11
|
+
The names are resolved on first access (``__getattr__``), so that importing the
|
|
12
|
+
package, or a module of a lower layer, loads neither the interface, the result layer
|
|
13
|
+
nor the solvers until a public function is used.
|
|
14
|
+
"""
|
|
15
|
+
|
|
16
|
+
from __future__ import annotations
|
|
17
|
+
|
|
18
|
+
import importlib
|
|
19
|
+
from typing import TYPE_CHECKING
|
|
20
|
+
|
|
21
|
+
if TYPE_CHECKING:
|
|
22
|
+
from powermean.api import NB2, fit, gpml, logols, ppml, prepare, solver_defaults
|
|
23
|
+
from powermean.data.inference_conventions import ssc
|
|
24
|
+
from powermean.errors import (
|
|
25
|
+
ConvergenceError,
|
|
26
|
+
CovarianceWarning,
|
|
27
|
+
CoverageWarning,
|
|
28
|
+
ExistenceError,
|
|
29
|
+
IdentificationError,
|
|
30
|
+
NumericalWarning,
|
|
31
|
+
SampleError,
|
|
32
|
+
SolverCapabilityError,
|
|
33
|
+
SpecificationError,
|
|
34
|
+
)
|
|
35
|
+
from powermean.solve.options import SolverOptions
|
|
36
|
+
|
|
37
|
+
__all__ = [
|
|
38
|
+
"NB2",
|
|
39
|
+
"ConvergenceError",
|
|
40
|
+
"CovarianceWarning",
|
|
41
|
+
"CoverageWarning",
|
|
42
|
+
"ExistenceError",
|
|
43
|
+
"IdentificationError",
|
|
44
|
+
"NumericalWarning",
|
|
45
|
+
"SampleError",
|
|
46
|
+
"SolverCapabilityError",
|
|
47
|
+
"SolverOptions",
|
|
48
|
+
"SpecificationError",
|
|
49
|
+
"fit",
|
|
50
|
+
"gpml",
|
|
51
|
+
"logols",
|
|
52
|
+
"ppml",
|
|
53
|
+
"prepare",
|
|
54
|
+
"solver_defaults",
|
|
55
|
+
"ssc",
|
|
56
|
+
]
|
|
57
|
+
|
|
58
|
+
# The module that defines each public name, resolved lazily.
|
|
59
|
+
_SOURCES: dict[str, str] = {
|
|
60
|
+
"NB2": "powermean.api",
|
|
61
|
+
"fit": "powermean.api",
|
|
62
|
+
"gpml": "powermean.api",
|
|
63
|
+
"logols": "powermean.api",
|
|
64
|
+
"ppml": "powermean.api",
|
|
65
|
+
"prepare": "powermean.api",
|
|
66
|
+
"solver_defaults": "powermean.api",
|
|
67
|
+
"ssc": "powermean.data.inference_conventions",
|
|
68
|
+
"SolverOptions": "powermean.solve.options",
|
|
69
|
+
"ConvergenceError": "powermean.errors",
|
|
70
|
+
"CovarianceWarning": "powermean.errors",
|
|
71
|
+
"CoverageWarning": "powermean.errors",
|
|
72
|
+
"ExistenceError": "powermean.errors",
|
|
73
|
+
"IdentificationError": "powermean.errors",
|
|
74
|
+
"NumericalWarning": "powermean.errors",
|
|
75
|
+
"SampleError": "powermean.errors",
|
|
76
|
+
"SolverCapabilityError": "powermean.errors",
|
|
77
|
+
"SpecificationError": "powermean.errors",
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
def __getattr__(name: str) -> object:
|
|
82
|
+
"""A public name, imported from its module on first access."""
|
|
83
|
+
source = _SOURCES.get(name)
|
|
84
|
+
if source is None:
|
|
85
|
+
raise AttributeError(f"module 'powermean' has no attribute {name!r}")
|
|
86
|
+
value: object = getattr(importlib.import_module(source), name)
|
|
87
|
+
globals()[name] = value
|
|
88
|
+
return value
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
def __dir__() -> list[str]:
|
|
92
|
+
"""The public names beside the attributes of the module."""
|
|
93
|
+
return sorted(set(globals()) | set(__all__))
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
"""Restricted native package: the exact FE incidence row reduction.
|
|
2
|
+
|
|
3
|
+
``_echelon_cpp`` (built from ``echelon.cpp`` by the top-level CMake project when
|
|
4
|
+
``POWERMEAN_BUILD_BASIS`` is on) is an optional accelerator of
|
|
5
|
+
:func:`powermean.fe.certificate_basis._operational_echelon`. Only that module
|
|
6
|
+
imports it, only after explicit ``basis_backend="cpp"`` selection. The Python
|
|
7
|
+
loop stays the specification and handles representation/work/allocation declines.
|
|
8
|
+
A missing or broken explicitly requested extension is an error. Defaults do not
|
|
9
|
+
probe this module.
|
|
10
|
+
"""
|
|
11
|
+
|
|
12
|
+
from __future__ import annotations
|
|
13
|
+
|
|
14
|
+
__all__: tuple[str, ...] = ()
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
"""Internal coordination of the formula front end with the sample construction.
|
|
2
|
+
|
|
3
|
+
:mod:`powermean.formula` evaluates a formula on every row with pandas and
|
|
4
|
+
Formulaic and may import no later stage; :mod:`powermean.data` constructs the sample
|
|
5
|
+
on arrays and may import neither pandas nor Formulaic nor the interface. The modules
|
|
6
|
+
of this package stand between them. :mod:`powermean._prepare.compose` reads an
|
|
7
|
+
evaluated :class:`~powermean.formula.frame.ModelFrame` and the columns of its data,
|
|
8
|
+
feeds arrays and masks to :func:`powermean.data.sample.build_sample`, and keeps the
|
|
9
|
+
user's pandas Index in a state of its own, selected by position only;
|
|
10
|
+
:mod:`powermean._prepare.effects` reads the raw labels of a formula's fixed-effect terms
|
|
11
|
+
by position and marks their missing values for step 2 of the sample construction.
|
|
12
|
+
They evaluate no formula, transform no outcome and fit nothing, and this package
|
|
13
|
+
exports no public name. No stage of the pipeline imports it.
|
|
14
|
+
"""
|
|
@@ -0,0 +1,337 @@
|
|
|
1
|
+
"""From an evaluated model frame to the sample construction, by position.
|
|
2
|
+
|
|
3
|
+
This module covers steps 1 ("parse the formula; evaluate transformations; apply
|
|
4
|
+
``subset``") and 2 of the sample construction. :func:`prepare_frame` takes a
|
|
5
|
+
:class:`~powermean.formula.frame.ModelFrame`, which Formulaic evaluated on every row of
|
|
6
|
+
the data, and the data themselves, and forms the arrays and masks of
|
|
7
|
+
:func:`powermean.data.sample.build_sample`:
|
|
8
|
+
|
|
9
|
+
- the raw outcome and the trained design as doubles, missing where the frame says so;
|
|
10
|
+
- the missing masks by group: ``outcome`` from the raw outcome; ``regressors`` from the
|
|
11
|
+
raw data columns that the regressors read (a Boolean transform can hide a missing
|
|
12
|
+
value, a missing category is encoded like the baseline) together with the evaluated
|
|
13
|
+
design (a transform can make a missing or infinite value from finite data), the two
|
|
14
|
+
masks kept apart on the frame; ``weights``, ``offset`` and ``clusters`` from their
|
|
15
|
+
raw columns, read by :mod:`powermean.formula.validity`;
|
|
16
|
+
- the raw weights as their original objects (:class:`~powermean.data.raw.RawWeights`),
|
|
17
|
+
the offset or the exposure as doubles, and the cluster and other requested columns
|
|
18
|
+
as aligned metadata, each as its original values.
|
|
19
|
+
|
|
20
|
+
The input extraction helpers live in :mod:`powermean._prepare.inputs`, the dependence
|
|
21
|
+
provenance records in :mod:`powermean._prepare.dependence`, and the pandas/frame axis
|
|
22
|
+
ownership helpers in :mod:`powermean._prepare.owned`. All extracted helpers are
|
|
23
|
+
re-exported here so existing callers of :mod:`powermean._prepare.compose` are unchanged.
|
|
24
|
+
"""
|
|
25
|
+
|
|
26
|
+
from __future__ import annotations
|
|
27
|
+
|
|
28
|
+
from collections.abc import Mapping
|
|
29
|
+
from dataclasses import dataclass
|
|
30
|
+
from typing import TYPE_CHECKING, Any
|
|
31
|
+
|
|
32
|
+
import pandas as pd
|
|
33
|
+
from numpy.typing import ArrayLike
|
|
34
|
+
|
|
35
|
+
from powermean._prepare.dependence import (
|
|
36
|
+
ColumnProvenance,
|
|
37
|
+
DependenceProvenance,
|
|
38
|
+
DependenceRole,
|
|
39
|
+
UsedDependence,
|
|
40
|
+
_prepare_dependence,
|
|
41
|
+
_retained_original,
|
|
42
|
+
prepare_dependence,
|
|
43
|
+
)
|
|
44
|
+
from powermean._prepare.effects import (
|
|
45
|
+
_native_effects, _native_effects_original, read_effects,
|
|
46
|
+
)
|
|
47
|
+
from powermean._prepare.inputs import (
|
|
48
|
+
Columns,
|
|
49
|
+
_check_same_data,
|
|
50
|
+
_column,
|
|
51
|
+
_doubles,
|
|
52
|
+
_inputs,
|
|
53
|
+
_nan,
|
|
54
|
+
_object_subset,
|
|
55
|
+
_subset_mask,
|
|
56
|
+
_values,
|
|
57
|
+
)
|
|
58
|
+
from powermean._prepare.owned import (
|
|
59
|
+
_holds_objects,
|
|
60
|
+
_owned_frame,
|
|
61
|
+
_owned_index,
|
|
62
|
+
_owned_multiindex,
|
|
63
|
+
_owned_names,
|
|
64
|
+
_owned_series,
|
|
65
|
+
_owned_table,
|
|
66
|
+
)
|
|
67
|
+
from powermean.data.accounting import MissingAccount, frozen_codes
|
|
68
|
+
from powermean.data.retained import OrderRows, OrderSample, _derive_order_parts
|
|
69
|
+
from powermean.data.sample import SampleBase, build_sample
|
|
70
|
+
from powermean.data.sample_fe import EffectColumns
|
|
71
|
+
from powermean.formula.frame import ModelFrame
|
|
72
|
+
from powermean.model.order import _flags
|
|
73
|
+
|
|
74
|
+
if TYPE_CHECKING:
|
|
75
|
+
__all__ = [
|
|
76
|
+
"ColumnProvenance",
|
|
77
|
+
"Columns",
|
|
78
|
+
"DependenceProvenance",
|
|
79
|
+
"DependenceRole",
|
|
80
|
+
"PreparedFrame",
|
|
81
|
+
"UsedDependence",
|
|
82
|
+
"_check_same_data",
|
|
83
|
+
"_column",
|
|
84
|
+
"_doubles",
|
|
85
|
+
"_holds_objects",
|
|
86
|
+
"_inputs",
|
|
87
|
+
"_nan",
|
|
88
|
+
"_object_subset",
|
|
89
|
+
"_owned_frame",
|
|
90
|
+
"_owned_index",
|
|
91
|
+
"_owned_multiindex",
|
|
92
|
+
"_owned_names",
|
|
93
|
+
"_owned_series",
|
|
94
|
+
"_owned_table",
|
|
95
|
+
"_subset_mask",
|
|
96
|
+
"_values",
|
|
97
|
+
"prepare_dependence",
|
|
98
|
+
"prepare_frame",
|
|
99
|
+
]
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
def _isolated_sample_base(base: SampleBase) -> SampleBase:
|
|
103
|
+
"""Return a ``SampleBase`` with fresh array objects for its masks."""
|
|
104
|
+
isolated_missing = MissingAccount._owned(
|
|
105
|
+
{group: _flags(mask) for group, mask in base.missing.groups.items()},
|
|
106
|
+
_flags(base.missing.excluded),
|
|
107
|
+
)
|
|
108
|
+
return SampleBase(
|
|
109
|
+
inputs=base.inputs,
|
|
110
|
+
subset=None if base.subset is None else _flags(base.subset),
|
|
111
|
+
missing=isolated_missing,
|
|
112
|
+
complete=_flags(base.complete),
|
|
113
|
+
negative_weight=_flags(base.negative_weight),
|
|
114
|
+
zero_weight=_flags(base.zero_weight),
|
|
115
|
+
codes=frozen_codes(base.codes),
|
|
116
|
+
)
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
@dataclass(frozen=True, eq=False, init=False)
|
|
120
|
+
class PreparedFrame:
|
|
121
|
+
"""The frame, its labels and the order-neutral sample base, in one owned state.
|
|
122
|
+
|
|
123
|
+
Parameters
|
|
124
|
+
----------
|
|
125
|
+
frame : ModelFrame
|
|
126
|
+
The evaluated frame, with the fitted spec of its design; copied.
|
|
127
|
+
labels : pandas.Index
|
|
128
|
+
The user's row labels, in input order, as given; copied, its object labels
|
|
129
|
+
and its names included (:func:`_owned_index`).
|
|
130
|
+
columns : Columns
|
|
131
|
+
The columns that were read.
|
|
132
|
+
base : SampleBase
|
|
133
|
+
The order-neutral state of the sample.
|
|
134
|
+
subset_missing : int
|
|
135
|
+
The number of rows whose subset condition was missing, excluded by the subset.
|
|
136
|
+
effects : EffectColumns, optional
|
|
137
|
+
The owned raw labels of the fixed-effect terms; ``None`` without a
|
|
138
|
+
fixed-effect part.
|
|
139
|
+
dependence : DependenceProvenance, optional
|
|
140
|
+
Fit-used and retained-only column provenance.
|
|
141
|
+
|
|
142
|
+
Attributes
|
|
143
|
+
----------
|
|
144
|
+
columns, base, subset_missing, effects, dependence
|
|
145
|
+
As given.
|
|
146
|
+
frame : ModelFrame
|
|
147
|
+
A fresh copy of the retained frame, its fitted spec, owned labels and owned
|
|
148
|
+
axes included, on every access.
|
|
149
|
+
labels : pandas.Index
|
|
150
|
+
A fresh owned copy of the retained labels on every access.
|
|
151
|
+
"""
|
|
152
|
+
|
|
153
|
+
columns: Columns
|
|
154
|
+
base: SampleBase
|
|
155
|
+
subset_missing: int
|
|
156
|
+
effects: EffectColumns | None
|
|
157
|
+
dependence: DependenceProvenance | None
|
|
158
|
+
_frame: ModelFrame
|
|
159
|
+
_labels: pd.Index[Any]
|
|
160
|
+
|
|
161
|
+
def __init__(
|
|
162
|
+
self,
|
|
163
|
+
*,
|
|
164
|
+
frame: ModelFrame,
|
|
165
|
+
labels: pd.Index[Any],
|
|
166
|
+
columns: Columns,
|
|
167
|
+
base: SampleBase,
|
|
168
|
+
subset_missing: int,
|
|
169
|
+
effects: EffectColumns | None = None,
|
|
170
|
+
dependence: DependenceProvenance | None = None,
|
|
171
|
+
) -> None:
|
|
172
|
+
"""Keep an owned copy of the frame and of the labels, and the rest as given."""
|
|
173
|
+
object.__setattr__(self, "columns", columns)
|
|
174
|
+
object.__setattr__(self, "base", base)
|
|
175
|
+
object.__setattr__(self, "subset_missing", subset_missing)
|
|
176
|
+
object.__setattr__(self, "effects", effects)
|
|
177
|
+
object.__setattr__(self, "dependence", dependence)
|
|
178
|
+
object.__setattr__(self, "_frame", _owned_frame(frame))
|
|
179
|
+
object.__setattr__(self, "_labels", _owned_index(labels))
|
|
180
|
+
|
|
181
|
+
@property
|
|
182
|
+
def frame(self) -> ModelFrame:
|
|
183
|
+
"""A fresh copy of the retained frame, with its fitted spec, learned once."""
|
|
184
|
+
return _owned_frame(self._frame)
|
|
185
|
+
|
|
186
|
+
@property
|
|
187
|
+
def labels(self) -> pd.Index[Any]:
|
|
188
|
+
"""A fresh owned copy of the user's row labels, in input order, as given."""
|
|
189
|
+
return _owned_index(self._labels)
|
|
190
|
+
|
|
191
|
+
def for_order(self, omega: float, *, positive_only: bool = False) -> OrderSample:
|
|
192
|
+
"""The sample of the mean order ``omega`` (:meth:`SampleBase.for_order`).
|
|
193
|
+
|
|
194
|
+
Uses an isolated copy of :attr:`base` and its :class:`MissingAccount` so that
|
|
195
|
+
no in-place shape or dtype mutation on the returned :class:`OrderSample`'s
|
|
196
|
+
missingness masks can reach this :class:`PreparedFrame`.
|
|
197
|
+
"""
|
|
198
|
+
return _isolated_sample_base(self.base).for_order(
|
|
199
|
+
omega, positive_only=positive_only
|
|
200
|
+
)
|
|
201
|
+
|
|
202
|
+
def _order_parts(
|
|
203
|
+
self, omega: float, *, positive_only: bool = False
|
|
204
|
+
) -> tuple[OrderSample, OrderRows]:
|
|
205
|
+
"""Fresh owned parts with the SAME authoritative base-mask isolation."""
|
|
206
|
+
return _derive_order_parts(
|
|
207
|
+
_isolated_sample_base(self.base), omega, positive_only=positive_only
|
|
208
|
+
)
|
|
209
|
+
|
|
210
|
+
def retained_labels(self, sample: OrderSample) -> pd.Index[Any]:
|
|
211
|
+
"""The user's labels of the retained rows of ``sample``, by position.
|
|
212
|
+
|
|
213
|
+
Parameters
|
|
214
|
+
----------
|
|
215
|
+
sample : OrderSample
|
|
216
|
+
A sample derived from this frame's base.
|
|
217
|
+
|
|
218
|
+
Returns
|
|
219
|
+
-------
|
|
220
|
+
pandas.Index
|
|
221
|
+
``labels.take(sample.positions)``: the same Index type, names and dtype,
|
|
222
|
+
duplicates and missing labels included; a fresh owned copy, whose object
|
|
223
|
+
labels and names are copies (:func:`_owned_index`).
|
|
224
|
+
|
|
225
|
+
Raises
|
|
226
|
+
------
|
|
227
|
+
ValueError
|
|
228
|
+
A sample of another number of input rows.
|
|
229
|
+
"""
|
|
230
|
+
if sample.nobs != len(self._labels):
|
|
231
|
+
raise ValueError("sample does not belong to this frame")
|
|
232
|
+
return _owned_index(self._labels.take(sample.positions))
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
def prepare_frame(
|
|
236
|
+
frame: ModelFrame,
|
|
237
|
+
data: pd.DataFrame,
|
|
238
|
+
*,
|
|
239
|
+
columns: Columns | None = None,
|
|
240
|
+
subset: pd.Series[Any] | ArrayLike | None = None,
|
|
241
|
+
dependence: UsedDependence | None = None,
|
|
242
|
+
) -> PreparedFrame:
|
|
243
|
+
"""Feed an evaluated frame to the sample construction, by position.
|
|
244
|
+
|
|
245
|
+
Parameters
|
|
246
|
+
----------
|
|
247
|
+
frame : ModelFrame
|
|
248
|
+
The frame of :func:`powermean.formula.frame.model_frame` on ``data``.
|
|
249
|
+
data : pandas.DataFrame
|
|
250
|
+
The data of the frame, read by position for the columns of ``columns``.
|
|
251
|
+
columns : Columns, optional
|
|
252
|
+
The weights, offset or exposure, cluster and metadata columns; none by
|
|
253
|
+
default.
|
|
254
|
+
subset : array_like of bool or pandas.Series, optional
|
|
255
|
+
The evaluated subset condition, one value per row (module docstring).
|
|
256
|
+
dependence : UsedDependence, optional
|
|
257
|
+
Additional fit-used dependence columns (whose invalid entries join the
|
|
258
|
+
existing ``clusters`` missing group) and retained-only columns (which
|
|
259
|
+
exclude no rows at the fit).
|
|
260
|
+
|
|
261
|
+
Returns
|
|
262
|
+
-------
|
|
263
|
+
PreparedFrame
|
|
264
|
+
An owned copy of the frame, its labels and the order-neutral base of the
|
|
265
|
+
sample.
|
|
266
|
+
"""
|
|
267
|
+
return _prepare_frame(
|
|
268
|
+
frame, data, columns=columns, subset=subset, dependence=dependence
|
|
269
|
+
)
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
def _prepare_frame(
|
|
273
|
+
frame: ModelFrame, data: pd.DataFrame, *, columns: Columns | None = None,
|
|
274
|
+
subset: pd.Series[Any] | ArrayLike | None = None,
|
|
275
|
+
dependence: UsedDependence | None = None,
|
|
276
|
+
_retained: Mapping[str, tuple[str, ...]] | None = None,
|
|
277
|
+
) -> PreparedFrame:
|
|
278
|
+
"""Shared preparation body; no public foreign-input ownership assertion."""
|
|
279
|
+
if type(frame) is not ModelFrame:
|
|
280
|
+
raise TypeError("frame must be a ModelFrame")
|
|
281
|
+
chosen = Columns() if columns is None else columns
|
|
282
|
+
_check_same_data(frame, data)
|
|
283
|
+
if _retained is None:
|
|
284
|
+
inputs, missing, provenance = prepare_dependence(
|
|
285
|
+
frame, data, chosen, dependence
|
|
286
|
+
)
|
|
287
|
+
else:
|
|
288
|
+
inputs, missing, provenance = _prepare_dependence(
|
|
289
|
+
frame, data, chosen, dependence, _retained=_retained
|
|
290
|
+
)
|
|
291
|
+
effects = None
|
|
292
|
+
if frame.parts.fixed_effects:
|
|
293
|
+
# Both components of an interaction mark step 2, before any grouping.
|
|
294
|
+
native = (
|
|
295
|
+
_native_effects(data, frame.parts.fixed_effects, provenance)
|
|
296
|
+
if _retained is not None and _native_retained_original() else None
|
|
297
|
+
)
|
|
298
|
+
effects, missing["effects"] = (
|
|
299
|
+
read_effects(data, frame.parts.fixed_effects) if native is None else native
|
|
300
|
+
)
|
|
301
|
+
mask, subset_missing = _subset_mask(subset, data)
|
|
302
|
+
base = build_sample(inputs, subset=mask, missing=missing)
|
|
303
|
+
return PreparedFrame(
|
|
304
|
+
frame=frame,
|
|
305
|
+
labels=frame.design.labels,
|
|
306
|
+
columns=chosen,
|
|
307
|
+
base=base,
|
|
308
|
+
subset_missing=subset_missing,
|
|
309
|
+
effects=effects,
|
|
310
|
+
dependence=provenance,
|
|
311
|
+
)
|
|
312
|
+
|
|
313
|
+
_RETAIN_DEPENDENCE = prepare_dependence
|
|
314
|
+
_RETAIN_NUMERIC_DEPENDENCE = _prepare_dependence
|
|
315
|
+
_RETAIN_EFFECTS = read_effects
|
|
316
|
+
_RETAIN_NATIVE_EFFECTS = _native_effects
|
|
317
|
+
_RETAIN_EFFECT_GUARD = _native_effects_original
|
|
318
|
+
_RETAIN_QUALIFY = _retained_original
|
|
319
|
+
_RETAIN_PREPARED = PreparedFrame
|
|
320
|
+
_RETAIN_FRAME_METHODS = tuple((name, vars(PreparedFrame).get(name)) for name in (
|
|
321
|
+
"__init__", "__getattribute__", "__getattr__", "for_order", "_order_parts",
|
|
322
|
+
))
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
def _native_retained_original() -> bool:
|
|
326
|
+
"""Qualify the existing normal producer, not an alternate preparation engine."""
|
|
327
|
+
return (prepare_dependence is _RETAIN_DEPENDENCE
|
|
328
|
+
and _prepare_dependence is _RETAIN_NUMERIC_DEPENDENCE
|
|
329
|
+
and read_effects is _RETAIN_EFFECTS
|
|
330
|
+
and _native_effects is _RETAIN_NATIVE_EFFECTS
|
|
331
|
+
and _native_effects_original is _RETAIN_EFFECT_GUARD
|
|
332
|
+
and _native_effects_original()
|
|
333
|
+
and _retained_original is _RETAIN_QUALIFY
|
|
334
|
+
and PreparedFrame is _RETAIN_PREPARED
|
|
335
|
+
and all(vars(PreparedFrame).get(name) is original
|
|
336
|
+
for name, original in _RETAIN_FRAME_METHODS)
|
|
337
|
+
and _retained_original())
|