{ "__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": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "", "annotation": "ZeroDivisionError", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "When all weights along axis are zero. See " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.ma.average", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "numpy", "version": "*", "kind": "api", "path": "numpy.ma.extras:average" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " for a version robust to this type of error." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "", "annotation": "TypeError", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "When " }, { "__type": "ParamRef", "__tag": 4071, "name": "weights" }, { "__type": "Text", "__tag": 4046, "value": " does not have the same shape as " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": ", and " }, { "__type": "InlineRole", "__tag": 4003, "value": "axis=None", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "", "annotation": "ValueError", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "When " }, { "__type": "ParamRef", "__tag": 4071, "name": "weights" }, { "__type": "Text", "__tag": 4046, "value": " does not have dimensions and shape consistent with " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " along specified " }, { "__type": "ParamRef", "__tag": 4071, "name": "axis" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ] } ], "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": "retval, [sum_of_weights]", "annotation": "array_type or double", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Return the average along the specified axis. When " }, { "__type": "ParamRef", "__tag": 4071, "name": "returned" }, { "__type": "Text", "__tag": 4046, "value": " is " }, { "__type": "InlineRole", "__tag": 4003, "value": "True", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", return a tuple with the average as the first element and the sum of the weights as the second element. " }, { "__type": "InlineRole", "__tag": 4003, "value": "sum_of_weights", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " is of the same type as " }, { "__type": "CrossRef", "__tag": 4002, "value": "retval", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "retval" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": ". The result dtype follows a general pattern. If " }, { "__type": "ParamRef", "__tag": 4071, "name": "weights" }, { "__type": "Text", "__tag": 4046, "value": " is None, the result dtype will be that of " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " , or " }, { "__type": "InlineCode", "__tag": 4051, "value": "float64" }, { "__type": "Text", "__tag": 4046, "value": " if " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " is integral. Otherwise, if " }, { "__type": "ParamRef", "__tag": 4071, "name": "weights" }, { "__type": "Text", "__tag": 4046, "value": " is not None and " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " is non- integral, the result type will be the type of lowest precision capable of representing values of both " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "ParamRef", "__tag": 4071, "name": "weights" }, { "__type": "Text", "__tag": 4046, "value": ". If " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " happens to be integral, the previous rules still applies but the result dtype will at least be " }, { "__type": "InlineCode", "__tag": 4051, "value": "float64" }, { "__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 weighted average along the specified axis." } ] } ], "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": "Array containing data to be averaged. If " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " is not an array, a conversion is attempted." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "axis", "annotation": "None or int or tuple of ints, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Axis or axes along which to average " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": ". The default, " }, { "__type": "InlineRole", "__tag": 4003, "value": "axis=None", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", will average over all of the elements of the input array. If axis is negative it counts from the last to the first axis. If axis is a tuple of ints, averaging is performed on all of the axes specified in the tuple instead of a single axis or all the axes as before." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "weights", "annotation": "array_like, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "An array of weights associated with the values in " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": ". Each value in " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " contributes to the average according to its associated weight. The array of weights must be the same shape as " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " if no axis is specified, otherwise the weights must have dimensions and shape consistent with " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " along the specified axis. If " }, { "__type": "InlineRole", "__tag": 4003, "value": "weights=None", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", then all data in " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " are assumed to have a weight equal to one. The calculation is " } ] }, { "__type": "Code", "__tag": 4050, "value": "avg = sum(a * weights) / sum(weights)", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "where the sum is over all included elements. The only constraint on the values of " }, { "__type": "ParamRef", "__tag": 4071, "name": "weights" }, { "__type": "Text", "__tag": 4046, "value": " is that " }, { "__type": "InlineRole", "__tag": 4003, "value": "sum(weights)", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " must not be 0." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "returned", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Default is " }, { "__type": "InlineRole", "__tag": 4003, "value": "False", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ". If " }, { "__type": "InlineRole", "__tag": 4003, "value": "True", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", the tuple (" }, { "__type": "CrossRef", "__tag": 4002, "value": "average", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:average" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineRole", "__tag": 4003, "value": "sum_of_weights", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ") is returned, otherwise only the average is returned. If " }, { "__type": "InlineRole", "__tag": 4003, "value": "weights=None", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineRole", "__tag": 4003, "value": "sum_of_weights", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " is equivalent to the number of elements over which the average is taken." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "keepdims", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If this is set to True, the axes which are reduced are left in the result as dimensions with size one. With this option, the result will broadcast correctly against the original " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": ". " }, { "__type": "Emphasis", "__tag": 4047, "children": [ { "__type": "Text", "__tag": 4046, "value": "Note:" } ] }, { "__type": "Text", "__tag": 4046, "value": " " }, { "__type": "ParamRef", "__tag": 4071, "name": "keepdims" }, { "__type": "Text", "__tag": 4046, "value": " will not work with instances of " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.matrix", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:matrix" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " or other classes whose methods do not support " }, { "__type": "ParamRef", "__tag": 4071, "name": "keepdims" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 1.23.0" } ] } ] } ] } ] } ], "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": "/dev/numpy/build-install/usr/lib/python3.14/site-packages/numpy/lib/_function_base_impl.py", "item_line": 439, "item_type": "_ArrayFunctionDispatcher", "aliases": [ "numpy.average" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\ndata = np.arange(1, 5)\ndata\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "np.average(data)\nnp.average(np.arange(1, 11), weights=np.arange(10, 0, -1))\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "data = np.arange(6).reshape((3, 2))\ndata\nnp.average(data, axis=1, weights=[1./4, 3./4])\nnp.average(data, weights=[1./4, 3./4])\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nWith ``keepdims=True``, the following result has shape (3, 1).\n\n" }, { "__type": "Code", "__tag": 4050, "value": "np.average(data, axis=1, keepdims=True)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "data = np.arange(8).reshape((2, 2, 2))\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "data\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "np.average(data, axis=(0, 1), weights=[[1./4, 3./4], [1., 1./2]])\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "np.average(data, axis=0, weights=[[1./4, 3./4], [1., 1./2]])\n", "execution_status": "failure" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "ma.average", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "ma.average" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "average for masked arrays -- useful if your data contains \"missing\" values" } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "mean", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "mean" }, "kind": "module" }, "descriptions": [], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "numpy.result_type", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:result_type" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Returns the type that results from applying the numpy type promotion rules to the arguments." } ] } ], "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": "axis", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "weights", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "returned", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "keepdims", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "average" }, "references": null, "qa": "numpy:average", "arbitrary": [], "local_refs": [ "[sum_of_weights]", "a", "axis", "keepdims", "returned", "retval", "weights" ] }