{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Strong", "__tag": 4048, "children": [ { "__type": "Text", "__tag": 4046, "value": "Array API Standard Support" } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "percentileofscore", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.stats._stats_py:percentileofscore" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " has experimental support for Python Array API Standard compatible backends in addition to NumPy. Please consider testing these features by setting an environment variable " }, { "__type": "InlineCode", "__tag": 4051, "value": "SCIPY_ARRAY_API=1" }, { "__type": "Text", "__tag": 4046, "value": " and providing CuPy, PyTorch, JAX, or Dask arrays as array arguments. The following combinations of backend and device (or other capability) are supported." } ] }, { "__type": "Code", "__tag": 4050, "value": "==================== ==================== ====================\nLibrary CPU GPU\n==================== ==================== ====================\nNumPy ✅ n/a \nCuPy n/a ⛔ \nPyTorch ⛔ ⛔ \nJAX ⛔ ⛔ \nDask ⛔ n/a \n==================== ==================== ====================", "execution_status": null }, { "__type": "Blockquote", "__tag": 4059, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "See " }, { "__type": "InlineRole", "__tag": 4003, "value": "dev-arrayapi", "domain": null, "role": "ref", "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " for more information." } ] } ] } ], "title": [], "level": 0, "target": null }, "Warns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Raises": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Yields": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Methods": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Returns": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "pcos", "annotation": "float or array-like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Percentile-position(s) of " }, { "__type": "ParamRef", "__tag": 4071, "name": "score" }, { "__type": "Text", "__tag": 4046, "value": " (0-100) relative to " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Compute the percentile rank of a score relative to a list of scores." } ] } ], "title": [], "level": 0, "target": null }, "Receives": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Warnings": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Attributes": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Parameters": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "a", "annotation": "array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A 1-D array to which " }, { "__type": "ParamRef", "__tag": 4071, "name": "score" }, { "__type": "Text", "__tag": 4046, "value": " is compared." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "score", "annotation": "float or array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A float score or array of scores for which to compute the percentile(s)." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "kind", "annotation": "{'rank', 'weak', 'strict', 'mean'}, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Specifies the interpretation of the resulting score. The following options are available (default is 'rank'):" } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'rank': Average percentage ranking of score. In case of multiple matches, average the percentage rankings of all matching scores." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'weak': This kind corresponds to the definition of a cumulative distribution function. A percentileofscore of 80% means that 80% of values are less than or equal to the provided score." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'strict': Similar to \"weak\", except that only values that are strictly less than the given score are counted." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'mean': The average of the \"weak\" and \"strict\" scores, often used in testing. See https://en.wikipedia.org/wiki/Percentile_rank" } ] } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "nan_policy", "annotation": "{'propagate', 'raise', 'omit'}, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Specifies how to treat " }, { "__type": "InlineRole", "__tag": 4003, "value": "nan", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " values in " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": ". The following options are available (default is 'propagate'):" } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'propagate': returns nan (for each value in " }, { "__type": "ParamRef", "__tag": 4071, "name": "score" }, { "__type": "Text", "__tag": 4046, "value": ")." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'raise': throws an error" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'omit': performs the calculations ignoring nan values" } ] } ] } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A " }, { "__type": "CrossRef", "__tag": 4002, "value": "percentileofscore", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.stats._stats_py:percentileofscore" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " of, for example, 80% means that 80% of the scores in " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " are below the given score. In the case of gaps or ties, the exact definition depends on the optional keyword, " }, { "__type": "ParamRef", "__tag": 4071, "name": "kind" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ], "title": [], "level": 0, "target": null }, "Other Parameters": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null } }, "_ordered_sections": [ "Summary", "Extended Summary", "Parameters", "Attributes", "Methods", "Returns", "Yields", "Receives", "Other Parameters", "Raises", "Warns", "Warnings", "Notes" ], "item_file": "/scipy/stats/_stats_py.py", "item_line": 2098, "item_type": "function", "aliases": [ "scipy.stats.percentileofscore" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "Three-quarters of the given values lie below a given score:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy import stats\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "stats.percentileofscore([1, 2, 3, 4], 3)\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nWith multiple matches, note how the scores of the two matches, 0.6\nand 0.8 respectively, are averaged:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "stats.percentileofscore([1, 2, 3, 3, 4], 3)\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nOnly 2/5 values are strictly less than 3:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "stats.percentileofscore([1, 2, 3, 3, 4], 3, kind='strict')\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nBut 4/5 values are less than or equal to 3:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "stats.percentileofscore([1, 2, 3, 3, 4], 3, kind='weak')\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nThe average between the weak and the strict scores is:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "stats.percentileofscore([1, 2, 3, 3, 4], 3, kind='mean')\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nScore arrays (of any dimensionality) are supported:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "stats.percentileofscore([1, 2, 3, 3, 4], [2, 3])\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nThe inputs can be infinite:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "stats.percentileofscore([-np.inf, 0, 1, np.inf], [1, 2, np.inf])\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nIf `a` is empty, then the resulting percentiles are all `nan`:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "stats.percentileofscore([], [1, 2])\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "numpy.percentile", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "numpy.percentile" }, "kind": "module" }, "descriptions": [], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "scipy.stats.rankdata", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.stats._stats_py:rankdata" }, "kind": "module" }, "descriptions": [], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "scipy.stats.scoreatpercentile", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.stats._stats_py:scoreatpercentile" }, "kind": "module" }, "descriptions": [], "type": "func" } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "a", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "score", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "kind", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "rank" }, { "__type": "SigParam", "__tag": 4030, "name": "nan_policy", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "propagate" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "percentileofscore" }, "references": null, "qa": "scipy.stats._stats_py:percentileofscore", "arbitrary": [], "local_refs": [ "a", "kind", "nan_policy", "pcos", "score" ] }