From 96a5909e28f672c29cd549d6d1ee3ed4e1a4e5f8 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Wed, 25 Sep 2024 09:46:36 +0000 Subject: [PATCH] Documentation based on 86af4d4aad5a9032337233d55b50178251bf71fd --- api.html | 2 ++ searchindex.js | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/api.html b/api.html index 02b00e3..6ae4ffb 100644 --- a/api.html +++ b/api.html @@ -658,6 +658,8 @@

QuaPy

generic_method – An instance of qunfold.methods.AbstractMethod to wrap.

+

Notes

+

If the generic_method defines a get_params and / or set_params function, this wrapper will forward any calls that it receives for these functions to the generic_method. If, otherwise, the generic_method instance is a LinearMethod, this wrapper will infer the get_params and set_params from the generic LinearMethod constructor. Else, it will infer the functions from the constructor of the class of the generic_method.

Examples

Here, we wrap an instance of ACC to perform a grid search with QuaPy.

>>> qunfold_method = QuaPyWrapper(ACC(RandomForestClassifier(obb_score=True)))
diff --git a/searchindex.js b/searchindex.js
index 1c44df7..8bbea7b 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"API": [[0, null]], "Classify and count": [[0, "classify-and-count"]], "Cross-validated training": [[0, "cross-validated-training"]], "Custom implementations": [[1, "custom-implementations"]], "Data representations": [[0, "data-representations"], [1, "data-representations"]], "Developer guide": [[1, null]], "Distribution matching": [[0, "distribution-matching"]], "Docker setup (optional)": [[2, "docker-setup-optional"]], "Documentation": [[1, "documentation"]], "Experiments": [[2, null]], "Installation": [[3, "installation"]], "Local setup (alternative)": [[2, "local-setup-alternative"]], "Losses": [[0, "losses"], [1, "losses"]], "Methods beyond systems of linear equations": [[0, "methods-beyond-systems-of-linear-equations"]], "Popular algorithms": [[0, "popular-algorithms"]], "QuaPy": [[0, "quapy"]], "Quickstart": [[3, null]], "Regularizers": [[0, "regularizers"]], "Running the experiments": [[2, "running-the-experiments"]], "Setup": [[2, "setup"]], "Unfolding": [[0, "unfolding"]], "Unit testing": [[1, "unit-testing"]], "Upgrading": [[3, "upgrading"]], "Usage": [[3, "usage"]], "Utilities": [[0, "utilities"]], "Workflow": [[1, "workflow"]]}, "docnames": ["api", "developer-guide", "experiments", "index"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["api.md", "developer-guide.md", "experiments.md", "index.md"], "indexentries": {"abstractloss (class in qunfold.methods.linear.losses)": [[1, "qunfold.methods.linear.losses.AbstractLoss", false]], "abstractmethod (class in qunfold)": [[0, "qunfold.AbstractMethod", false]], "abstractrepresentation (class in qunfold.methods.linear.representations)": [[1, "qunfold.methods.linear.representations.AbstractRepresentation", false]], "acc (class in qunfold)": [[0, "qunfold.ACC", false]], "blobelloss (class in qunfold)": [[0, "qunfold.BlobelLoss", false]], "classrepresentation (class in qunfold)": [[0, "qunfold.ClassRepresentation", false]], "combinedloss (class in qunfold)": [[0, "qunfold.CombinedLoss", false]], "cvclassifier (class in qunfold.sklearn)": [[0, "qunfold.sklearn.CVClassifier", false]], "distancerepresentation (class in qunfold)": [[0, "qunfold.DistanceRepresentation", false]], "edx (class in qunfold)": [[0, "qunfold.EDx", false]], "edy (class in qunfold)": [[0, "qunfold.EDy", false]], "energykernelrepresentation (class in qunfold)": [[0, "qunfold.EnergyKernelRepresentation", false]], "energyloss (class in qunfold)": [[0, "qunfold.EnergyLoss", false]], "expectationmaximizer (class in qunfold)": [[0, "qunfold.ExpectationMaximizer", false]], "fit() (qunfold.abstractmethod method)": [[0, "qunfold.AbstractMethod.fit", false]], "fit() (qunfold.linearmethod method)": [[0, "qunfold.LinearMethod.fit", false]], "fit_transform() (qunfold.methods.linear.representations.abstractrepresentation method)": [[1, "qunfold.methods.linear.representations.AbstractRepresentation.fit_transform", false]], "functionloss (class in qunfold.methods.linear.losses)": [[1, "qunfold.methods.linear.losses.FunctionLoss", false]], "gaussiankernelrepresentation (class in qunfold)": [[0, "qunfold.GaussianKernelRepresentation", false]], "gaussianrffkernelrepresentation (class in qunfold)": [[0, "qunfold.GaussianRFFKernelRepresentation", false]], "hdx (class in qunfold)": [[0, "qunfold.HDx", false]], "hdy (class in qunfold)": [[0, "qunfold.HDy", false]], "hellingersurrogateloss (class in qunfold)": [[0, "qunfold.HellingerSurrogateLoss", false]], "histogramrepresentation (class in qunfold)": [[0, "qunfold.HistogramRepresentation", false]], "instantiate() (qunfold.methods.linear.losses.abstractloss method)": [[1, "qunfold.methods.linear.losses.AbstractLoss.instantiate", false]], "kernelrepresentation (class in qunfold)": [[1, "qunfold.KernelRepresentation", false]], "kmm (class in qunfold)": [[0, "qunfold.KMM", false]], "laplaciankernelrepresentation (class in qunfold)": [[0, "qunfold.LaplacianKernelRepresentation", false]], "leastsquaresloss (class in qunfold)": [[0, "qunfold.LeastSquaresLoss", false]], "likelihoodmaximizer (class in qunfold)": [[0, "qunfold.LikelihoodMaximizer", false]], "linearmethod (class in qunfold)": [[0, "qunfold.LinearMethod", false]], "pacc (class in qunfold)": [[0, "qunfold.PACC", false]], "predict() (qunfold.abstractmethod method)": [[0, "qunfold.AbstractMethod.predict", false]], "predict() (qunfold.linearmethod method)": [[0, "qunfold.LinearMethod.predict", false]], "quapywrapper (class in qunfold.quapy)": [[0, "qunfold.quapy.QuaPyWrapper", false]], "run (class in qunfold)": [[0, "qunfold.RUN", false]], "solve() (qunfold.linearmethod method)": [[0, "qunfold.LinearMethod.solve", false]], "tikhonovregularization (class in qunfold)": [[0, "qunfold.TikhonovRegularization", false]], "tikhonovregularized() (in module qunfold)": [[0, "qunfold.TikhonovRegularized", false]], "transform() (qunfold.methods.linear.representations.abstractrepresentation method)": [[1, "qunfold.methods.linear.representations.AbstractRepresentation.transform", false]]}, "objects": {"qunfold": [[0, 0, 1, "", "ACC"], [0, 0, 1, "", "AbstractMethod"], [0, 0, 1, "", "BlobelLoss"], [0, 0, 1, "", "ClassRepresentation"], [0, 0, 1, "", "CombinedLoss"], [0, 0, 1, "", "DistanceRepresentation"], [0, 0, 1, "", "EDx"], [0, 0, 1, "", "EDy"], [0, 0, 1, "", "EnergyKernelRepresentation"], [0, 0, 1, "", "EnergyLoss"], [0, 0, 1, "", "ExpectationMaximizer"], [0, 0, 1, "", "GaussianKernelRepresentation"], [0, 0, 1, "", "GaussianRFFKernelRepresentation"], [0, 0, 1, "", "HDx"], [0, 0, 1, "", "HDy"], [0, 0, 1, "", "HellingerSurrogateLoss"], [0, 0, 1, "", "HistogramRepresentation"], [0, 0, 1, "", "KMM"], [1, 0, 1, "", "KernelRepresentation"], [0, 0, 1, "", "LaplacianKernelRepresentation"], [0, 0, 1, "", "LeastSquaresLoss"], [0, 0, 1, "", "LikelihoodMaximizer"], [0, 0, 1, "", "LinearMethod"], [0, 0, 1, "", "PACC"], [0, 0, 1, "", "RUN"], [0, 0, 1, "", "TikhonovRegularization"], [0, 2, 1, "", "TikhonovRegularized"]], "qunfold.AbstractMethod": [[0, 1, 1, "", "fit"], [0, 1, 1, "", "predict"]], "qunfold.LinearMethod": [[0, 1, 1, "", "fit"], [0, 1, 1, "", "predict"], [0, 1, 1, "", "solve"]], "qunfold.methods.linear.losses": [[1, 0, 1, "", "AbstractLoss"], [1, 0, 1, "", "FunctionLoss"]], "qunfold.methods.linear.losses.AbstractLoss": [[1, 1, 1, "", "instantiate"]], "qunfold.methods.linear.representations": [[1, 0, 1, "", "AbstractRepresentation"]], "qunfold.methods.linear.representations.AbstractRepresentation": [[1, 1, 1, "", "fit_transform"], [1, 1, 1, "", "transform"]], "qunfold.quapy": [[0, 0, 1, "", "QuaPyWrapper"]], "qunfold.sklearn": [[0, 0, 1, "", "CVClassifier"]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "method", "Python method"], "2": ["py", "function", "Python function"]}, "objtypes": {"0": "py:class", "1": "py:method", "2": "py:function"}, "terms": {"0": [0, 1, 2, 3], "01": [0, 3], "08": 0, "1": 0, "10": [0, 3], "100": 0, "1000": 0, "1985": 0, "1e": 0, "2": 0, "2002": 0, "2008": 0, "2010": 0, "2013": 0, "2016": 0, "2019": 0, "2020": 0, "2022": 0, "2023": 0, "2\u03c3": 0, "5": 0, "8": 0, "A": [0, 1], "As": 1, "For": [0, 1], "If": [0, 1], "In": [0, 1, 3], "It": [0, 3], "Not": 0, "The": [0, 1, 2, 3], "Their": 0, "To": [1, 2, 3], "about": 1, "abstract": [0, 1], "abstractloss": 1, "abstractmethod": 0, "abstractrepresent": [0, 1], "acc": [0, 3], "accept": 0, "action": 1, "ad": 0, "add": 0, "adjust": [0, 3], "after": 1, "al": 0, "alexandari": 0, "algorithm": 3, "all": [0, 3], "allow": 0, "alreadi": 1, "also": [0, 1], "alwai": 0, "an": [0, 2, 3], "ani": [0, 1], "anoth": 0, "approach": 0, "approxim": 0, "ar": [0, 1, 2], "arbitrari": 0, "argument": 0, "arrai": [0, 1], "art": 3, "assumpt": 0, "asymptot": 0, "attribut": 0, "auto": 1, "averag": [0, 1, 2], "axi": 1, "back": 3, "backend": 3, "bag": 0, "base": [0, 1], "basic": 3, "becaus": 0, "befor": [0, 1], "behavior": 0, "being": [0, 3], "bella": 0, "best": 1, "between": 0, "bin": [0, 1, 2], "blobel": 0, "blobelloss": 0, "both": [0, 1], "branch": 1, "browser": 1, "build": 1, "buns": 0, "call": [0, 1, 2], "callabl": [0, 1], "can": [0, 1, 2, 3], "case": 1, "casta\u00f1o": 0, "castro": 0, "categor": 0, "cc": 0, "cd": 2, "cdist": 0, "chang": 2, "check": 1, "check_i": 1, "choic": 0, "class": [0, 1], "class_preval": 1, "classif": 0, "classifi": 3, "classrepresent": [0, 3], "code": [1, 2], "com": 3, "combin": 0, "combinedloss": 0, "comparison": 2, "complic": 0, "compos": 3, "composit": [0, 3], "comput": 0, "consist": 0, "constraint": 1, "constructor": 0, "contain": 2, "control": 0, "conveni": [1, 2], "converg": 0, "correspond": 0, "count": 3, "cpu": 3, "creat": [0, 1, 2], "create_t": 2, "crisp": 0, "criteria": 0, "cross": 3, "csv": 2, "custom": 3, "cvclassifi": [0, 3], "data": [2, 3], "dedic": 1, "def": 1, "default": [0, 1], "defin": 0, "dep": 3, "depend": 2, "deriv": 1, "design": 3, "detail": 1, "deviat": 0, "differenti": [0, 1], "directli": 0, "distanc": 0, "distancerepresent": 0, "do": [0, 1], "doc": 1, "document": 2, "don": 1, "dot": 1, "dussap": 0, "e": [1, 2], "each": 0, "easi": 1, "easili": 3, "edi": 0, "edx": 0, "effici": [0, 1], "effort": 2, "either": [0, 2], "element": 0, "embed": 1, "enabl": 3, "end": 3, "energi": [0, 1], "energykernelrepresent": 0, "energyloss": 0, "ensembl": [0, 3], "ensur": [0, 1], "entir": 2, "entropi": 0, "environ": 2, "equival": 0, "error": 0, "estim": [0, 3], "et": 0, "euclidean": 0, "exampl": [0, 1, 3], "execut": 2, "exist": [0, 1, 3], "exp": 0, "expect": [0, 1], "expectationmaxim": 0, "express": 1, "f": 1, "facilit": 2, "fals": [0, 1], "featur": [0, 1], "final": 2, "fit": [0, 1, 3], "fit_classifi": 0, "fit_transform": 1, "fix": 0, "fold": [0, 3], "follow": [0, 1, 2, 3], "forc": 3, "forest": 0, "forman": 0, "fourier": 0, "framework": 3, "freedom": 1, "from": [0, 1, 2, 3], "function": [0, 1, 2, 3], "functionloss": 1, "gaussian": [0, 1], "gaussiankernelrepresent": 0, "gaussianrffkernelrepresent": 0, "gener": [0, 1], "generic_method": 0, "gh": 1, "gini": 0, "git": 3, "github": [1, 3], "go": [0, 1], "gonz\u00e1lez": 0, "grid": 0, "gridsearchq": 0, "gtol": 0, "ha": 1, "have": [0, 1], "hdx": 0, "hdy": 0, "helling": 0, "hellingersurrogateloss": 0, "help": 2, "henc": [0, 1], "here": 0, "histogram": 0, "histogramrepresent": 0, "home": 2, "hopkin": 0, "how": 1, "howev": 0, "html": 1, "http": [1, 3], "i": [0, 1, 2, 3], "ideal": 3, "imag": 2, "implement": [0, 2, 3], "import": [0, 1, 3], "importantli": 0, "independ": 0, "index": 1, "indic": 0, "input": 1, "insid": 2, "instal": [0, 1, 2], "instanc": [0, 1], "instanti": [0, 1], "instead": 0, "intend": 1, "interfac": 0, "introduc": 1, "io": 1, "is_full_run": 2, "is_probabilist": 0, "is_test_run": 2, "isol": 2, "item": [0, 1], "iter": 0, "itself": 0, "j": [0, 1], "jax": [1, 3], "jnp": 1, "just": [0, 1], "k": 0, "kawakubo": 0, "kernel": [0, 1], "kernelrepresent": [0, 1], "keyword": 0, "king": 0, "kmm": [0, 1], "known": 0, "kwarg": 0, "l2": 0, "label": [0, 1], "lambda": 1, "laplacian": 0, "laplaciankernelrepresent": 0, "latent": 1, "latter": 0, "learn": 0, "least": 1, "least_squar": 1, "least_squares_loss": 1, "leastsquaresloss": [0, 3], "lequa": 2, "lequa2022": 2, "lequa_result": 2, "leverag": 3, "like": [0, 1], "likelihood": 0, "likelihoodmaxim": 0, "linear": 1, "linearmethod": [0, 1, 3], "local": 1, "logist": 0, "logisticregress": [0, 3], "loss": 3, "loss_funct": 1, "loss_valu": 1, "m": [0, 1, 2], "main": [1, 2, 3], "make": [0, 2], "mani": 0, "manual": 1, "matrix": [0, 1], "max": [0, 1], "max_it": 0, "maxim": 0, "maximum": 0, "maxit": 0, "mean": 1, "measur": 0, "method": [1, 3], "metric": 0, "minim": [0, 2], "mirkobuns": [1, 3], "mnt": 2, "model": 0, "model_select": 0, "modul": 0, "more": 1, "moreov": 3, "most": [0, 1], "multipl": 0, "must": 1, "n": [0, 1], "n_bin": 0, "n_class": [0, 1], "n_estim": 0, "n_job": 2, "n_rff": 0, "navig": 2, "ncg": 0, "need": [0, 3], "new": 3, "non": 0, "none": [0, 1], "norm": 0, "note": 0, "novel": 3, "number": [0, 1], "numer": 0, "numpi": [0, 1], "obb_scor": 0, "object": [0, 1], "often": 0, "one": 0, "oob": 3, "oob_decision_function_": 0, "oob_scor": [0, 3], "open": 1, "optim": [0, 3], "option": [0, 1], "order": 0, "ordin": [0, 3], "ordinal_acc": 3, "origin": [0, 3], "our": [1, 3], "out": [0, 1], "output": 0, "over": 1, "own": 0, "p": [0, 1], "p_hat": 3, "p_trn": 1, "pacc": 0, "packag": [1, 3], "page": 1, "param_grid": 0, "paramet": [0, 1], "particular": 1, "particularli": 2, "path": 2, "pcc": 0, "penal": 0, "perform": [0, 2, 3], "pip": [1, 2, 3], "pleas": 1, "poisson": 0, "posterior": 0, "power": [1, 3], "practic": 1, "predict": [0, 3], "prefer": 1, "prepar": 3, "preprocessor": 0, "preval": [0, 3], "probabilist": 0, "probabl": [0, 1], "problem": 0, "problemat": 0, "promot": 0, "properti": 1, "propos": 0, "proven": 0, "provid": [0, 1, 2], "publish": 1, "push": 1, "python": [1, 2, 3], "q": [0, 1], "quantif": [0, 3], "quantifi": [0, 3], "quapi": [2, 3], "quapywrapp": [0, 3], "qunfold": [0, 1, 2, 3], "qunfold_method": 0, "random": 0, "random_st": 0, "randomforestclassifi": [0, 3], "randomst": 0, "rate": 0, "readi": [1, 3], "readm": 0, "regard": 1, "regress": 0, "regular": [1, 3], "reinstal": 3, "replac": 2, "repositori": 2, "repres": [0, 1], "represent": 3, "representation__classifier__estimator__criterion": 0, "requir": [0, 1], "result": 1, "return": [0, 1], "rff": 0, "run": [0, 1, 3], "saeren": 0, "sampl": 0, "saniti": 1, "scalar": [0, 1], "scale": 0, "scikit": 0, "scipi": 0, "search": 0, "second": 0, "seed": 0, "self": [0, 1], "set": [0, 1], "setuptool": 3, "sh": 2, "should": 1, "sigma": 0, "signatur": [0, 1], "similar": 2, "simpli": 1, "sklearn": [0, 3], "sld": 0, "smooth": 0, "so": 1, "soft": [0, 1], "solut": 0, "solv": 0, "solver": 0, "solver_opt": 0, "some": 0, "soon": 1, "sourc": 1, "spatial": 0, "sphinx": 1, "split": 0, "squar": [0, 1], "start": 2, "state": [0, 3], "stratif": 0, "stratifi": 0, "strength": [0, 3], "studi": 0, "sub": [0, 1], "subclass": 0, "subtyp": 1, "sum": 0, "support": [0, 1], "switch": 2, "t": 1, "tabl": 2, "take": [0, 1], "tau": 0, "tau_0": 0, "tau_1": 0, "term": [0, 1], "test": 2, "tex": 2, "than": 1, "thei": 1, "therebi": 1, "thi": [0, 1, 2, 3], "thin": 0, "those": 1, "through": [0, 2], "tikhonov": 0, "tikhonovregular": [0, 3], "togeth": 0, "tol": 0, "toler": 0, "too": 1, "toward": 0, "train": 3, "transfer": 1, "transform": 1, "transpar": 2, "trick": [0, 1], "true": [0, 1, 3], "trust": 0, "try": 0, "twice": 0, "two": 0, "type": 0, "typic": 3, "unconstrain": 0, "under": 0, "unfold": 3, "unifi": 3, "uniform": 0, "unit_scal": 0, "unittest": 1, "us": [0, 1, 2, 3], "valid": [2, 3], "valu": [0, 2], "variant": [0, 3], "vector": [0, 1, 3], "venv": [1, 2], "wai": 1, "we": [0, 1, 2, 3], "weight": 0, "well": 0, "wheel": 3, "when": 0, "where": 1, "whether": [0, 1, 2], "which": [0, 1], "wise": [0, 1], "without": 2, "work": 2, "worri": 1, "would": 1, "wrap": 0, "wrapper": [0, 1], "x": [0, 1], "x_1": 0, "x_2": 0, "x_trn": 3, "x_tst": 3, "y": [0, 1], "y_trn": 3, "yield": 3, "you": [0, 1, 2, 3], "your": [0, 1]}, "titles": ["API", "Developer guide", "Experiments", "Quickstart"], "titleterms": {"algorithm": 0, "altern": 2, "api": 0, "beyond": 0, "classifi": 0, "count": 0, "cross": 0, "custom": 1, "data": [0, 1], "develop": 1, "distribut": 0, "docker": 2, "document": 1, "equat": 0, "experi": 2, "guid": 1, "implement": 1, "instal": 3, "linear": 0, "local": 2, "loss": [0, 1], "match": 0, "method": 0, "option": 2, "popular": 0, "quapi": 0, "quickstart": 3, "regular": 0, "represent": [0, 1], "run": 2, "setup": 2, "system": 0, "test": 1, "train": 0, "unfold": 0, "unit": 1, "upgrad": 3, "usag": 3, "util": 0, "valid": 0, "workflow": 1}})
\ No newline at end of file
+Search.setIndex({"alltitles": {"API": [[0, null]], "Classify and count": [[0, "classify-and-count"]], "Cross-validated training": [[0, "cross-validated-training"]], "Custom implementations": [[1, "custom-implementations"]], "Data representations": [[0, "data-representations"], [1, "data-representations"]], "Developer guide": [[1, null]], "Distribution matching": [[0, "distribution-matching"]], "Docker setup (optional)": [[2, "docker-setup-optional"]], "Documentation": [[1, "documentation"]], "Experiments": [[2, null]], "Installation": [[3, "installation"]], "Local setup (alternative)": [[2, "local-setup-alternative"]], "Losses": [[0, "losses"], [1, "losses"]], "Methods beyond systems of linear equations": [[0, "methods-beyond-systems-of-linear-equations"]], "Popular algorithms": [[0, "popular-algorithms"]], "QuaPy": [[0, "quapy"]], "Quickstart": [[3, null]], "Regularizers": [[0, "regularizers"]], "Running the experiments": [[2, "running-the-experiments"]], "Setup": [[2, "setup"]], "Unfolding": [[0, "unfolding"]], "Unit testing": [[1, "unit-testing"]], "Upgrading": [[3, "upgrading"]], "Usage": [[3, "usage"]], "Utilities": [[0, "utilities"]], "Workflow": [[1, "workflow"]]}, "docnames": ["api", "developer-guide", "experiments", "index"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["api.md", "developer-guide.md", "experiments.md", "index.md"], "indexentries": {"abstractloss (class in qunfold.methods.linear.losses)": [[1, "qunfold.methods.linear.losses.AbstractLoss", false]], "abstractmethod (class in qunfold)": [[0, "qunfold.AbstractMethod", false]], "abstractrepresentation (class in qunfold.methods.linear.representations)": [[1, "qunfold.methods.linear.representations.AbstractRepresentation", false]], "acc (class in qunfold)": [[0, "qunfold.ACC", false]], "blobelloss (class in qunfold)": [[0, "qunfold.BlobelLoss", false]], "classrepresentation (class in qunfold)": [[0, "qunfold.ClassRepresentation", false]], "combinedloss (class in qunfold)": [[0, "qunfold.CombinedLoss", false]], "cvclassifier (class in qunfold.sklearn)": [[0, "qunfold.sklearn.CVClassifier", false]], "distancerepresentation (class in qunfold)": [[0, "qunfold.DistanceRepresentation", false]], "edx (class in qunfold)": [[0, "qunfold.EDx", false]], "edy (class in qunfold)": [[0, "qunfold.EDy", false]], "energykernelrepresentation (class in qunfold)": [[0, "qunfold.EnergyKernelRepresentation", false]], "energyloss (class in qunfold)": [[0, "qunfold.EnergyLoss", false]], "expectationmaximizer (class in qunfold)": [[0, "qunfold.ExpectationMaximizer", false]], "fit() (qunfold.abstractmethod method)": [[0, "qunfold.AbstractMethod.fit", false]], "fit() (qunfold.linearmethod method)": [[0, "qunfold.LinearMethod.fit", false]], "fit_transform() (qunfold.methods.linear.representations.abstractrepresentation method)": [[1, "qunfold.methods.linear.representations.AbstractRepresentation.fit_transform", false]], "functionloss (class in qunfold.methods.linear.losses)": [[1, "qunfold.methods.linear.losses.FunctionLoss", false]], "gaussiankernelrepresentation (class in qunfold)": [[0, "qunfold.GaussianKernelRepresentation", false]], "gaussianrffkernelrepresentation (class in qunfold)": [[0, "qunfold.GaussianRFFKernelRepresentation", false]], "hdx (class in qunfold)": [[0, "qunfold.HDx", false]], "hdy (class in qunfold)": [[0, "qunfold.HDy", false]], "hellingersurrogateloss (class in qunfold)": [[0, "qunfold.HellingerSurrogateLoss", false]], "histogramrepresentation (class in qunfold)": [[0, "qunfold.HistogramRepresentation", false]], "instantiate() (qunfold.methods.linear.losses.abstractloss method)": [[1, "qunfold.methods.linear.losses.AbstractLoss.instantiate", false]], "kernelrepresentation (class in qunfold)": [[1, "qunfold.KernelRepresentation", false]], "kmm (class in qunfold)": [[0, "qunfold.KMM", false]], "laplaciankernelrepresentation (class in qunfold)": [[0, "qunfold.LaplacianKernelRepresentation", false]], "leastsquaresloss (class in qunfold)": [[0, "qunfold.LeastSquaresLoss", false]], "likelihoodmaximizer (class in qunfold)": [[0, "qunfold.LikelihoodMaximizer", false]], "linearmethod (class in qunfold)": [[0, "qunfold.LinearMethod", false]], "pacc (class in qunfold)": [[0, "qunfold.PACC", false]], "predict() (qunfold.abstractmethod method)": [[0, "qunfold.AbstractMethod.predict", false]], "predict() (qunfold.linearmethod method)": [[0, "qunfold.LinearMethod.predict", false]], "quapywrapper (class in qunfold.quapy)": [[0, "qunfold.quapy.QuaPyWrapper", false]], "run (class in qunfold)": [[0, "qunfold.RUN", false]], "solve() (qunfold.linearmethod method)": [[0, "qunfold.LinearMethod.solve", false]], "tikhonovregularization (class in qunfold)": [[0, "qunfold.TikhonovRegularization", false]], "tikhonovregularized() (in module qunfold)": [[0, "qunfold.TikhonovRegularized", false]], "transform() (qunfold.methods.linear.representations.abstractrepresentation method)": [[1, "qunfold.methods.linear.representations.AbstractRepresentation.transform", false]]}, "objects": {"qunfold": [[0, 0, 1, "", "ACC"], [0, 0, 1, "", "AbstractMethod"], [0, 0, 1, "", "BlobelLoss"], [0, 0, 1, "", "ClassRepresentation"], [0, 0, 1, "", "CombinedLoss"], [0, 0, 1, "", "DistanceRepresentation"], [0, 0, 1, "", "EDx"], [0, 0, 1, "", "EDy"], [0, 0, 1, "", "EnergyKernelRepresentation"], [0, 0, 1, "", "EnergyLoss"], [0, 0, 1, "", "ExpectationMaximizer"], [0, 0, 1, "", "GaussianKernelRepresentation"], [0, 0, 1, "", "GaussianRFFKernelRepresentation"], [0, 0, 1, "", "HDx"], [0, 0, 1, "", "HDy"], [0, 0, 1, "", "HellingerSurrogateLoss"], [0, 0, 1, "", "HistogramRepresentation"], [0, 0, 1, "", "KMM"], [1, 0, 1, "", "KernelRepresentation"], [0, 0, 1, "", "LaplacianKernelRepresentation"], [0, 0, 1, "", "LeastSquaresLoss"], [0, 0, 1, "", "LikelihoodMaximizer"], [0, 0, 1, "", "LinearMethod"], [0, 0, 1, "", "PACC"], [0, 0, 1, "", "RUN"], [0, 0, 1, "", "TikhonovRegularization"], [0, 2, 1, "", "TikhonovRegularized"]], "qunfold.AbstractMethod": [[0, 1, 1, "", "fit"], [0, 1, 1, "", "predict"]], "qunfold.LinearMethod": [[0, 1, 1, "", "fit"], [0, 1, 1, "", "predict"], [0, 1, 1, "", "solve"]], "qunfold.methods.linear.losses": [[1, 0, 1, "", "AbstractLoss"], [1, 0, 1, "", "FunctionLoss"]], "qunfold.methods.linear.losses.AbstractLoss": [[1, 1, 1, "", "instantiate"]], "qunfold.methods.linear.representations": [[1, 0, 1, "", "AbstractRepresentation"]], "qunfold.methods.linear.representations.AbstractRepresentation": [[1, 1, 1, "", "fit_transform"], [1, 1, 1, "", "transform"]], "qunfold.quapy": [[0, 0, 1, "", "QuaPyWrapper"]], "qunfold.sklearn": [[0, 0, 1, "", "CVClassifier"]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "method", "Python method"], "2": ["py", "function", "Python function"]}, "objtypes": {"0": "py:class", "1": "py:method", "2": "py:function"}, "terms": {"0": [0, 1, 2, 3], "01": [0, 3], "08": 0, "1": 0, "10": [0, 3], "100": 0, "1000": 0, "1985": 0, "1e": 0, "2": 0, "2002": 0, "2008": 0, "2010": 0, "2013": 0, "2016": 0, "2019": 0, "2020": 0, "2022": 0, "2023": 0, "2\u03c3": 0, "5": 0, "8": 0, "A": [0, 1], "As": 1, "For": [0, 1], "If": [0, 1], "In": [0, 1, 3], "It": [0, 3], "Not": 0, "The": [0, 1, 2, 3], "Their": 0, "To": [1, 2, 3], "about": 1, "abstract": [0, 1], "abstractloss": 1, "abstractmethod": 0, "abstractrepresent": [0, 1], "acc": [0, 3], "accept": 0, "action": 1, "ad": 0, "add": 0, "adjust": [0, 3], "after": 1, "al": 0, "alexandari": 0, "algorithm": 3, "all": [0, 3], "allow": 0, "alreadi": 1, "also": [0, 1], "alwai": 0, "an": [0, 2, 3], "ani": [0, 1], "anoth": 0, "approach": 0, "approxim": 0, "ar": [0, 1, 2], "arbitrari": 0, "argument": 0, "arrai": [0, 1], "art": 3, "assumpt": 0, "asymptot": 0, "attribut": 0, "auto": 1, "averag": [0, 1, 2], "axi": 1, "back": 3, "backend": 3, "bag": 0, "base": [0, 1], "basic": 3, "becaus": 0, "befor": [0, 1], "behavior": 0, "being": [0, 3], "bella": 0, "best": 1, "between": 0, "bin": [0, 1, 2], "blobel": 0, "blobelloss": 0, "both": [0, 1], "branch": 1, "browser": 1, "build": 1, "buns": 0, "call": [0, 1, 2], "callabl": [0, 1], "can": [0, 1, 2, 3], "case": 1, "casta\u00f1o": 0, "castro": 0, "categor": 0, "cc": 0, "cd": 2, "cdist": 0, "chang": 2, "check": 1, "check_i": 1, "choic": 0, "class": [0, 1], "class_preval": 1, "classif": 0, "classifi": 3, "classrepresent": [0, 3], "code": [1, 2], "com": 3, "combin": 0, "combinedloss": 0, "comparison": 2, "complic": 0, "compos": 3, "composit": [0, 3], "comput": 0, "consist": 0, "constraint": 1, "constructor": 0, "contain": 2, "control": 0, "conveni": [1, 2], "converg": 0, "correspond": 0, "count": 3, "cpu": 3, "creat": [0, 1, 2], "create_t": 2, "crisp": 0, "criteria": 0, "cross": 3, "csv": 2, "custom": 3, "cvclassifi": [0, 3], "data": [2, 3], "dedic": 1, "def": 1, "default": [0, 1], "defin": 0, "dep": 3, "depend": 2, "deriv": 1, "design": 3, "detail": 1, "deviat": 0, "differenti": [0, 1], "directli": 0, "distanc": 0, "distancerepresent": 0, "do": [0, 1], "doc": 1, "document": 2, "don": 1, "dot": 1, "dussap": 0, "e": [1, 2], "each": 0, "easi": 1, "easili": 3, "edi": 0, "edx": 0, "effici": [0, 1], "effort": 2, "either": [0, 2], "element": 0, "els": 0, "embed": 1, "enabl": 3, "end": 3, "energi": [0, 1], "energykernelrepresent": 0, "energyloss": 0, "ensembl": [0, 3], "ensur": [0, 1], "entir": 2, "entropi": 0, "environ": 2, "equival": 0, "error": 0, "estim": [0, 3], "et": 0, "euclidean": 0, "exampl": [0, 1, 3], "execut": 2, "exist": [0, 1, 3], "exp": 0, "expect": [0, 1], "expectationmaxim": 0, "express": 1, "f": 1, "facilit": 2, "fals": [0, 1], "featur": [0, 1], "final": 2, "fit": [0, 1, 3], "fit_classifi": 0, "fit_transform": 1, "fix": 0, "fold": [0, 3], "follow": [0, 1, 2, 3], "forc": 3, "forest": 0, "forman": 0, "forward": 0, "fourier": 0, "framework": 3, "freedom": 1, "from": [0, 1, 2, 3], "function": [0, 1, 2, 3], "functionloss": 1, "gaussian": [0, 1], "gaussiankernelrepresent": 0, "gaussianrffkernelrepresent": 0, "gener": [0, 1], "generic_method": 0, "get_param": 0, "gh": 1, "gini": 0, "git": 3, "github": [1, 3], "go": [0, 1], "gonz\u00e1lez": 0, "grid": 0, "gridsearchq": 0, "gtol": 0, "ha": 1, "have": [0, 1], "hdx": 0, "hdy": 0, "helling": 0, "hellingersurrogateloss": 0, "help": 2, "henc": [0, 1], "here": 0, "histogram": 0, "histogramrepresent": 0, "home": 2, "hopkin": 0, "how": 1, "howev": 0, "html": 1, "http": [1, 3], "i": [0, 1, 2, 3], "ideal": 3, "imag": 2, "implement": [0, 2, 3], "import": [0, 1, 3], "importantli": 0, "independ": 0, "index": 1, "indic": 0, "infer": 0, "input": 1, "insid": 2, "instal": [0, 1, 2], "instanc": [0, 1], "instanti": [0, 1], "instead": 0, "intend": 1, "interfac": 0, "introduc": 1, "io": 1, "is_full_run": 2, "is_probabilist": 0, "is_test_run": 2, "isol": 2, "item": [0, 1], "iter": 0, "itself": 0, "j": [0, 1], "jax": [1, 3], "jnp": 1, "just": [0, 1], "k": 0, "kawakubo": 0, "kernel": [0, 1], "kernelrepresent": [0, 1], "keyword": 0, "king": 0, "kmm": [0, 1], "known": 0, "kwarg": 0, "l2": 0, "label": [0, 1], "lambda": 1, "laplacian": 0, "laplaciankernelrepresent": 0, "latent": 1, "latter": 0, "learn": 0, "least": 1, "least_squar": 1, "least_squares_loss": 1, "leastsquaresloss": [0, 3], "lequa": 2, "lequa2022": 2, "lequa_result": 2, "leverag": 3, "like": [0, 1], "likelihood": 0, "likelihoodmaxim": 0, "linear": 1, "linearmethod": [0, 1, 3], "local": 1, "logist": 0, "logisticregress": [0, 3], "loss": 3, "loss_funct": 1, "loss_valu": 1, "m": [0, 1, 2], "main": [1, 2, 3], "make": [0, 2], "mani": 0, "manual": 1, "matrix": [0, 1], "max": [0, 1], "max_it": 0, "maxim": 0, "maximum": 0, "maxit": 0, "mean": 1, "measur": 0, "method": [1, 3], "metric": 0, "minim": [0, 2], "mirkobuns": [1, 3], "mnt": 2, "model": 0, "model_select": 0, "modul": 0, "more": 1, "moreov": 3, "most": [0, 1], "multipl": 0, "must": 1, "n": [0, 1], "n_bin": 0, "n_class": [0, 1], "n_estim": 0, "n_job": 2, "n_rff": 0, "navig": 2, "ncg": 0, "need": [0, 3], "new": 3, "non": 0, "none": [0, 1], "norm": 0, "note": 0, "novel": 3, "number": [0, 1], "numer": 0, "numpi": [0, 1], "obb_scor": 0, "object": [0, 1], "often": 0, "one": 0, "oob": 3, "oob_decision_function_": 0, "oob_scor": [0, 3], "open": 1, "optim": [0, 3], "option": [0, 1], "order": 0, "ordin": [0, 3], "ordinal_acc": 3, "origin": [0, 3], "otherwis": 0, "our": [1, 3], "out": [0, 1], "output": 0, "over": 1, "own": 0, "p": [0, 1], "p_hat": 3, "p_trn": 1, "pacc": 0, "packag": [1, 3], "page": 1, "param_grid": 0, "paramet": [0, 1], "particular": 1, "particularli": 2, "path": 2, "pcc": 0, "penal": 0, "perform": [0, 2, 3], "pip": [1, 2, 3], "pleas": 1, "poisson": 0, "posterior": 0, "power": [1, 3], "practic": 1, "predict": [0, 3], "prefer": 1, "prepar": 3, "preprocessor": 0, "preval": [0, 3], "probabilist": 0, "probabl": [0, 1], "problem": 0, "problemat": 0, "promot": 0, "properti": 1, "propos": 0, "proven": 0, "provid": [0, 1, 2], "publish": 1, "push": 1, "python": [1, 2, 3], "q": [0, 1], "quantif": [0, 3], "quantifi": [0, 3], "quapi": [2, 3], "quapywrapp": [0, 3], "qunfold": [0, 1, 2, 3], "qunfold_method": 0, "random": 0, "random_st": 0, "randomforestclassifi": [0, 3], "randomst": 0, "rate": 0, "readi": [1, 3], "readm": 0, "receiv": 0, "regard": 1, "regress": 0, "regular": [1, 3], "reinstal": 3, "replac": 2, "repositori": 2, "repres": [0, 1], "represent": 3, "representation__classifier__estimator__criterion": 0, "requir": [0, 1], "result": 1, "return": [0, 1], "rff": 0, "run": [0, 1, 3], "saeren": 0, "sampl": 0, "saniti": 1, "scalar": [0, 1], "scale": 0, "scikit": 0, "scipi": 0, "search": 0, "second": 0, "seed": 0, "self": [0, 1], "set": [0, 1], "set_param": 0, "setuptool": 3, "sh": 2, "should": 1, "sigma": 0, "signatur": [0, 1], "similar": 2, "simpli": 1, "sklearn": [0, 3], "sld": 0, "smooth": 0, "so": 1, "soft": [0, 1], "solut": 0, "solv": 0, "solver": 0, "solver_opt": 0, "some": 0, "soon": 1, "sourc": 1, "spatial": 0, "sphinx": 1, "split": 0, "squar": [0, 1], "start": 2, "state": [0, 3], "stratif": 0, "stratifi": 0, "strength": [0, 3], "studi": 0, "sub": [0, 1], "subclass": 0, "subtyp": 1, "sum": 0, "support": [0, 1], "switch": 2, "t": 1, "tabl": 2, "take": [0, 1], "tau": 0, "tau_0": 0, "tau_1": 0, "term": [0, 1], "test": 2, "tex": 2, "than": 1, "thei": 1, "therebi": 1, "thi": [0, 1, 2, 3], "thin": 0, "those": 1, "through": [0, 2], "tikhonov": 0, "tikhonovregular": [0, 3], "togeth": 0, "tol": 0, "toler": 0, "too": 1, "toward": 0, "train": 3, "transfer": 1, "transform": 1, "transpar": 2, "trick": [0, 1], "true": [0, 1, 3], "trust": 0, "try": 0, "twice": 0, "two": 0, "type": 0, "typic": 3, "unconstrain": 0, "under": 0, "unfold": 3, "unifi": 3, "uniform": 0, "unit_scal": 0, "unittest": 1, "us": [0, 1, 2, 3], "valid": [2, 3], "valu": [0, 2], "variant": [0, 3], "vector": [0, 1, 3], "venv": [1, 2], "wai": 1, "we": [0, 1, 2, 3], "weight": 0, "well": 0, "wheel": 3, "when": 0, "where": 1, "whether": [0, 1, 2], "which": [0, 1], "wise": [0, 1], "without": 2, "work": 2, "worri": 1, "would": 1, "wrap": 0, "wrapper": [0, 1], "x": [0, 1], "x_1": 0, "x_2": 0, "x_trn": 3, "x_tst": 3, "y": [0, 1], "y_trn": 3, "yield": 3, "you": [0, 1, 2, 3], "your": [0, 1]}, "titles": ["API", "Developer guide", "Experiments", "Quickstart"], "titleterms": {"algorithm": 0, "altern": 2, "api": 0, "beyond": 0, "classifi": 0, "count": 0, "cross": 0, "custom": 1, "data": [0, 1], "develop": 1, "distribut": 0, "docker": 2, "document": 1, "equat": 0, "experi": 2, "guid": 1, "implement": 1, "instal": 3, "linear": 0, "local": 2, "loss": [0, 1], "match": 0, "method": 0, "option": 2, "popular": 0, "quapi": 0, "quickstart": 3, "regular": 0, "represent": [0, 1], "run": 2, "setup": 2, "system": 0, "test": 1, "train": 0, "unfold": 0, "unit": 1, "upgrad": 3, "usag": 3, "util": 0, "valid": 0, "workflow": 1}})
\ No newline at end of file