o .wi@sddlmZddlmZmZmZmZddlZddlmZm Z ddl m Z ddl m Z ddlmZmZddlmZmZdd lmZdd lmZmZesMd gZGd d d eZdS))Sequence)AnyCallableOptionalUnionN)Tensortensor)Literal)retrieval_fall_out)RetrievalMetric_retrieval_aggregate)_flexible_bincount dim_zero_cat)_MATPLOTLIB_AVAILABLE)_AX_TYPE_PLOT_OUT_TYPERetrievalFallOut.plotc seZdZUdZdZeed<dZeed<dZeed<dZ e ed<dZ e ed < d d e de ede edeedefdedd f fdd ZdefddZdededefddZ d!de eeeefde edefddZZS)"RetrievalFallOuta Compute `Fall-out`_. Works with binary target data. Accepts float predictions from a model output. As input to ``forward`` and ``update`` the metric accepts the following input: - ``preds`` (:class:`~torch.Tensor`): A float tensor of shape ``(N, ...)`` - ``target`` (:class:`~torch.Tensor`): A long or bool tensor of shape ``(N, ...)`` - ``indexes`` (:class:`~torch.Tensor`): A long tensor of shape ``(N, ...)`` which indicate to which query a prediction belongs As output to ``forward`` and ``compute`` the metric returns the following output: - ``fallout@k`` (:class:`~torch.Tensor`): A tensor with the computed metric All ``indexes``, ``preds`` and ``target`` must have the same dimension and will be flatten at the beginning, so that for example, a tensor of shape ``(N, M)`` is treated as ``(N * M, )``. Predictions will be first grouped by ``indexes`` and then will be computed as the mean of the metric over each query. Args: empty_target_action: Specify what to do with queries that do not have at least a negative ``target``. Choose from: - ``'neg'``: those queries count as ``0.0`` (default) - ``'pos'``: those queries count as ``1.0`` - ``'skip'``: skip those queries; if all queries are skipped, ``0.0`` is returned - ``'error'``: raise a ``ValueError`` ignore_index: Ignore predictions where the target is equal to this number. top_k: Consider only the top k elements for each query (default: `None`, which considers them all) aggregation: Specify how to aggregate over indexes. Can either a custom callable function that takes in a single tensor and returns a scalar value or one of the following strings: - ``'mean'``: average value is returned - ``'median'``: median value is returned - ``'max'``: max value is returned - ``'min'``: min value is returned kwargs: Additional keyword arguments, see :ref:`Metric kwargs` for more info. Raises: ValueError: If ``empty_target_action`` is not one of ``error``, ``skip``, ``neg`` or ``pos``. ValueError: If ``ignore_index`` is not `None` or an integer. ValueError: If ``top_k`` is not ``None`` or not an integer greater than 0. Example: >>> from torchmetrics.retrieval import RetrievalFallOut >>> indexes = tensor([0, 0, 0, 1, 1, 1, 1]) >>> preds = tensor([0.2, 0.3, 0.5, 0.1, 0.3, 0.5, 0.2]) >>> target = tensor([False, False, True, False, True, False, True]) >>> rfo = RetrievalFallOut(top_k=2) >>> rfo(preds, target, indexes=indexes) tensor(0.5000) Fis_differentiablehigher_is_betterfull_state_updateplot_lower_bound?plot_upper_boundposNmeanempty_target_action ignore_indextop_k aggregation)rmedianminmaxkwargsreturnc sFtjd|||d||durt|tr|dkstd||_dS)N)rrr rz,`top_k` has to be a positive integer or None)super__init__ isinstanceint ValueErrorr)selfrrrr r$ __class__r&\/home/ubuntu/sommelier/.venv/lib/python3.10/site-packages/torchmetrics/retrieval/fall_out.pyr(bs zRetrievalFallOut.__init__cst|j}t|jt|j}t|\}}|||}t| }g}t tj |ddtj ||ddD]6\}}d| sh|j dkrNtd|j dkr[|tdq;|j dkrg|td q;||||q;|rttfd d |D|jd Std S) aFirst concat state ``indexes``, ``preds`` and ``target`` since they were stored as lists. After that, compute list of groups that will help in keeping together predictions about the same query. Finally, for each group compute the `_metric` if the number of negative targets is at least 1, otherwise behave as specified by `self.empty_target_action`. r)dimerrorzC`compute` method was provided with a query with no negative target.rrnegrcsg|]}|qSr&)to).0xpredsr&r/ sz,RetrievalFallOut.compute..)r )rindexesr8targettorchsortr detachcputolistzipsplitsumrr+appendr_metricr stackr r4)r,r:r;indices split_sizesres mini_preds mini_targetr&r7r/computeus2       " zRetrievalFallOut.computer8r;cCst|||jdS)N)r)r r)r,r8r;r&r&r/rEszRetrievalFallOut._metricvalaxcCs |||S)a[Plot a single or multiple values from the metric. Args: val: Either a single result from calling `metric.forward` or `metric.compute` or a list of these results. If no value is provided, will automatically call `metric.compute` and plot that result. ax: An matplotlib axis object. If provided will add plot to that axis Returns: Figure and Axes object Raises: ModuleNotFoundError: If `matplotlib` is not installed .. plot:: :scale: 75 >>> import torch >>> from torchmetrics.retrieval import RetrievalFallOut >>> # Example plotting a single value >>> metric = RetrievalFallOut() >>> metric.update(torch.rand(10,), torch.randint(2, (10,)), indexes=torch.randint(2,(10,))) >>> fig_, ax_ = metric.plot() .. plot:: :scale: 75 >>> import torch >>> from torchmetrics.retrieval import RetrievalFallOut >>> # Example plotting multiple values >>> metric = RetrievalFallOut() >>> values = [] >>> for _ in range(10): ... values.append(metric(torch.rand(10,), torch.randint(2, (10,)), indexes=torch.randint(2,(10,)))) >>> fig, ax = metric.plot(values) )_plot)r,rMrNr&r&r/plots (r)rNNr)NN)__name__ __module__ __qualname____doc__rbool__annotations__rrrfloatrstrrr*rr rrr(rrLrErrrrP __classcell__r&r&r-r/rsD  <    'r)collections.abcrtypingrrrrr<rrtyping_extensionsr *torchmetrics.functional.retrieval.fall_outr torchmetrics.retrieval.baser r torchmetrics.utilities.datar rtorchmetrics.utilities.importsrtorchmetrics.utilities.plotrr__doctest_skip__rr&r&r&r/s