{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Setting user-specified probabilities through " }, { "__type": "InlineCode", "__tag": 4051, "value": "p" }, { "__type": "Text", "__tag": 4046, "value": " uses a more general but less efficient sampler than the default. The general sampler produces a different sample than the optimized sampler even if each element of " }, { "__type": "InlineCode", "__tag": 4051, "value": "p" }, { "__type": "Text", "__tag": 4046, "value": " is 1 / len(a)." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "p" }, { "__type": "Text", "__tag": 4046, "value": " must sum to 1 when cast to " }, { "__type": "InlineCode", "__tag": 4051, "value": "float64" }, { "__type": "Text", "__tag": 4046, "value": ". To ensure this, you may wish to normalize using " }, { "__type": "InlineCode", "__tag": 4051, "value": "p = p / np.sum(p, dtype=float)" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "When passing " }, { "__type": "InlineCode", "__tag": 4051, "value": "a" }, { "__type": "Text", "__tag": 4046, "value": " as an integer type and " }, { "__type": "InlineCode", "__tag": 4051, "value": "size" }, { "__type": "Text", "__tag": 4046, "value": " is not specified, the return type is a native Python " }, { "__type": "InlineCode", "__tag": 4051, "value": "int" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ], "title": [], "level": 0, "target": null }, "Warns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Raises": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "", "annotation": "ValueError", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If a is an int and less than zero, if p is not 1-dimensional, if a is array-like with a size 0, if p is not a vector of probabilities, if a and p have different lengths, or if replace=False and the sample size is greater than the population size." } ] } ] } ] } ], "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": "samples", "annotation": "single item or ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The generated random samples" } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Generates a random sample from a given array" } ] } ], "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, int}", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If an ndarray, a random sample is generated from its elements. If an int, the random sample is generated from np.arange(a)." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "size", "annotation": "{int, tuple[int]}, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Output shape. If the given shape is, e.g., " }, { "__type": "InlineCode", "__tag": 4051, "value": "(m, n, k)" }, { "__type": "Text", "__tag": 4046, "value": ", then " }, { "__type": "InlineCode", "__tag": 4051, "value": "m * n * k" }, { "__type": "Text", "__tag": 4046, "value": " samples are drawn from the 1-d " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": ". If " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " has more than one dimension, the " }, { "__type": "ParamRef", "__tag": 4071, "name": "size" }, { "__type": "Text", "__tag": 4046, "value": " shape will be inserted into the " }, { "__type": "ParamRef", "__tag": 4071, "name": "axis" }, { "__type": "Text", "__tag": 4046, "value": " dimension, so the output " }, { "__type": "InlineCode", "__tag": 4051, "value": "ndim" }, { "__type": "Text", "__tag": 4046, "value": " will be " }, { "__type": "InlineCode", "__tag": 4051, "value": "a.ndim - 1 + len(size)" }, { "__type": "Text", "__tag": 4046, "value": ". Default is None, in which case a single value is returned." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "replace", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Whether the sample is with or without replacement. Default is True, meaning that a value of " }, { "__type": "InlineCode", "__tag": 4051, "value": "a" }, { "__type": "Text", "__tag": 4046, "value": " can be selected multiple times." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "p", "annotation": "1-D array_like, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The probabilities associated with each entry in a. If not given, the sample assumes a uniform distribution over all entries in " }, { "__type": "InlineCode", "__tag": 4051, "value": "a" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "axis", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The axis along which the selection is performed. The default, 0, selects by row." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "shuffle", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Whether the sample is shuffled when sampling without replacement. Default is True, False provides a speedup." } ] } ] } ] } ], "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": null, "item_line": null, "item_type": "cython_function_or_method", "aliases": [ "numpy.random.Generator.choice" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "Generate a uniform random sample from np.arange(5) of size 3:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "rng = np.random.default_rng()\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "rng.choice(5, 3)\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nGenerate a non-uniform random sample from np.arange(5) of size 3:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "rng.choice(5, 3, p=[0.1, 0, 0.3, 0.6, 0])\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nGenerate a uniform random sample from np.arange(5) of size 3 without\nreplacement:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "rng.choice(5, 3, replace=False)\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nGenerate a uniform random sample from a 2-D array along the first\naxis (the default), without replacement:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "rng.choice([[0, 1, 2], [3, 4, 5], [6, 7, 8]], 2, replace=False)\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nGenerate a non-uniform random sample from np.arange(5) of size\n3 without replacement:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "rng.choice(5, 3, replace=False, p=[0.1, 0, 0.3, 0.6, 0])\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nAny of the above can be repeated with an arbitrary array-like\ninstead of just integers. For instance:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "aa_milne_arr = ['pooh', 'rabbit', 'piglet', 'Christopher']\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "rng.choice(aa_milne_arr, 5, p=[0.5, 0.1, 0.1, 0.3])\n", "execution_status": "failure" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "integers", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.random._generator:Generator.integers" }, "kind": "module" }, "descriptions": [], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "permutation", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.random._generator:Generator.permutation" }, "kind": "module" }, "descriptions": [], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "shuffle", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.random._generator:Generator.shuffle" }, "kind": "module" }, "descriptions": [], "type": null } ], "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": "size", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "replace", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "True" }, { "__type": "SigParam", "__tag": 4030, "name": "p", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "axis", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "0" }, { "__type": "SigParam", "__tag": 4030, "name": "shuffle", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "True" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "choice" }, "references": null, "qa": "numpy.random._generator:Generator.choice", "arbitrary": [], "local_refs": [ "a", "axis", "p", "replace", "samples", "shuffle", "size" ] }