Skip to content

Commit

Permalink
Docstring clarification (#2270)
Browse files Browse the repository at this point in the history
Summary:
Pull Request resolved: #2270

As titled

Created from CodeHub with https://fburl.com/edit-in-codehub

Reviewed By: mgarrard

Differential Revision: D54851822

fbshipit-source-id: 283ebc6d5a26595f52ddbfbbcf457bf252a56879
  • Loading branch information
Lena Kashtelyan authored and facebook-github-bot committed Apr 4, 2024
1 parent c7601b4 commit 577d54e
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion ax/utils/common/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,17 @@ class SortableBase(Base, metaclass=abc.ABCMeta):
@abc.abstractmethod
def _unique_id(self) -> str:
"""Returns an identification string that can be used to uniquely
identify this instance from others attached to the same experiment.
identify this instance from others attached to the same parent
object. For example, for ``Trials`` this can be their index,
since that is unique w.r.t. to parent ``Experiment`` object.
For ``GenerationNode``-s attached to a ``GenerationStrategy``,
this can be their name since we ensure uniqueness of it upon
``GenerationStrategy`` instantiation.
This method is needed to correctly update SQLAlchemy objects
that appear as children of other objects, in lists or other
sortable collections or containers.
"""
pass

Expand Down

0 comments on commit 577d54e

Please sign in to comment.