{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [], "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": [], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Random sample from the distribution." } ] } ], "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": "shape", "annotation": "tuple of ints, default: ()", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The shape of the sample to draw. If the parameters of the distribution underlying the random variable are arrays of shape " }, { "__type": "InlineCode", "__tag": 4051, "value": "param_shape" }, { "__type": "Text", "__tag": 4046, "value": ", the output array will be of shape " }, { "__type": "InlineCode", "__tag": 4051, "value": "shape + param_shape" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "method", "annotation": "{None, 'formula', 'inverse_transform'}", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The strategy used to produce the sample. By default (" }, { "__type": "InlineCode", "__tag": 4051, "value": "None" }, { "__type": "Text", "__tag": 4046, "value": "), the infrastructure chooses between the following options, listed in order of precedence." } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "'formula'" }, { "__type": "Text", "__tag": 4046, "value": ": an implementation specific to the distribution" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "'inverse_transform'" }, { "__type": "Text", "__tag": 4046, "value": ": generate a uniformly distributed sample and return the inverse CDF at these arguments." } ] } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Not all " }, { "__type": "ParamRef", "__tag": 4071, "name": "method" }, { "__type": "Text", "__tag": 4046, "value": " options are available for all distributions. If the selected " }, { "__type": "ParamRef", "__tag": 4071, "name": "method" }, { "__type": "Text", "__tag": 4046, "value": " is not available, a " }, { "__type": "InlineRole", "__tag": 4003, "value": "NotImplementedError'", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " will be raised." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "rng", "annotation": "`numpy.random.Generator` or `scipy.stats.QMCEngine`, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Pseudo- or quasi-random number generator state. When " }, { "__type": "ParamRef", "__tag": 4071, "name": "rng" }, { "__type": "Text", "__tag": 4046, "value": " is None, a new " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.random.Generator", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "numpy", "version": "*", "kind": "api", "path": "numpy.random._generator:Generator" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " is created using entropy from the operating system. Types other than " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.random.Generator", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "numpy", "version": "*", "kind": "api", "path": "numpy.random._generator:Generator" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineRole", "__tag": 4003, "value": "scipy.stats.QMCEngine", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " are passed to " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.random.default_rng", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "numpy", "version": "*", "kind": "api", "path": "numpy.random:default_rng" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " to instantiate a " }, { "__type": "InlineCode", "__tag": 4051, "value": "Generator" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "ParamRef", "__tag": 4071, "name": "rng" }, { "__type": "Text", "__tag": 4046, "value": " is an instance of " }, { "__type": "InlineRole", "__tag": 4003, "value": "scipy.stats.QMCEngine", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " configured to use scrambling and " }, { "__type": "ParamRef", "__tag": 4071, "name": "shape" }, { "__type": "Text", "__tag": 4046, "value": " is not empty, then each slice along the zeroth axis of the result is a \"quasi-independent\", low-discrepancy sequence; that is, they are distinct sequences that can be treated as statistically independent for most practical purposes. Separate calls to " }, { "__type": "CrossRef", "__tag": 4002, "value": "sample", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.stats._probability_distribution:_ProbabilityDistribution.sample" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " produce new quasi-independent, low-discrepancy sequences." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [], "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/_probability_distribution.py", "item_line": 112, "item_type": "function", "aliases": [ "scipy.stats._distribution_infrastructure._ProbabilityDistribution.sample" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "Instantiate a distribution with the desired parameters:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy import stats\nX = stats.Uniform(a=0., b=1.)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nGenerate a pseudorandom sample:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "x = X.sample((1000, 1))\noctiles = (np.arange(8) + 1) / 8\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "np.count_nonzero(x <= octiles, axis=0)\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "X = stats.Uniform(a=np.zeros((3, 1)), b=np.ones(2))\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "X.a.shape,\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "x = X.sample(shape=(5, 4))\nx.shape\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "self", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "shape", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "method", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "rng", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": { "__type": "Empty", "__tag": 4031 } } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "sample" }, "references": [ ".. [1] Sampling (statistics), *Wikipedia*,", " https://en.wikipedia.org/wiki/Sampling_(statistics)" ], "qa": "scipy.stats._probability_distribution:_ProbabilityDistribution.sample", "arbitrary": [], "local_refs": [ "method", "rng", "shape" ] }