damccorm commented on code in PR #33845:
URL: https://github.com/apache/beam/pull/33845#discussion_r1946763160
##########
sdks/python/apache_beam/ml/anomaly/specifiable.py:
##########
@@ -30,67 +34,119 @@
from typing_extensions import Self
+__all__ = ["KNOWN_SPECIFIABLE", "Spec", "Specifiable", "specifiable"]
+
ACCEPTED_SPECIFIABLE_SUBSPACES = [
"EnsembleAnomalyDetector",
"AnomalyDetector",
"ThresholdFn",
"AggregationFn",
"*"
]
+
+#: A nested dictionary for efficient lookup of Specifiable subclasses.
+#: Structure: KNOWN_SPECIFIABLE[subspace][spec_type], where "subspace" is one
of
+#: the accepted subspaces that the class belongs to and "spec_type" is the
class
+#: name by default. Users can also specify a different value for "spec_type"
+#: when applying the `specifiable` decorator to an existing class.
KNOWN_SPECIFIABLE = {"*": {}}
SpecT = TypeVar('SpecT', bound='Specifiable')
-def get_subspace(cls, type=None):
- if type is None:
- subspace = "*"
- for c in cls.mro():
- if c.__name__ in ACCEPTED_SPECIFIABLE_SUBSPACES:
- subspace = c.__name__
- break
- return subspace
- else:
- for subspace in ACCEPTED_SPECIFIABLE_SUBSPACES:
- if subspace in KNOWN_SPECIFIABLE and type in KNOWN_SPECIFIABLE[subspace]:
- return subspace
+def _class_to_subspace(cls: Type, default="*") -> str:
+ """
+ Search the class hierarchy to find the subspace: the closest ancestor class
in
+ the class's method resolution order (MRO) whose name is found in the accepted
+ subspace list. This is usually called when registering a new Specifiable
+ class.
+ """
+ for c in cls.mro():
+ #
+ if c.__name__ in ACCEPTED_SPECIFIABLE_SUBSPACES:
+ return c.__name__
+
+ if default is None:
Review Comment:
Aren't we setting a default? Will this ever be None?
##########
sdks/python/apache_beam/ml/anomaly/specifiable.py:
##########
@@ -0,0 +1,223 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+from __future__ import annotations
+
+import dataclasses
+import inspect
+import logging
+from typing import Any
+from typing import ClassVar
+from typing import List
+from typing import Protocol
+from typing import Type
+from typing import TypeVar
+from typing import runtime_checkable
+
+from typing_extensions import Self
+
+ACCEPTED_SPECIFIABLE_SUBSPACES = [
Review Comment:
> The purpose is to avoid using a global space for every specifiable classes.
I think maybe this is the piece I'm missing - why is this helpful? Aka, why
is it helpful to have a nested `KNOWN_SPECIFIABLE[subspace][spec_type]` dict
instead of just `KNOWN_SPECIFIABLE[spec_type]`. I can't really think of
scenarios this enables/makes easier
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
