clearml icon indicating copy to clipboard operation
clearml copied to clipboard

Duplicate methods with confusing names in DataView class

Open IliaSmagloy opened this issue 2 years ago • 2 comments

Hello, This is my first issue around here so I hope I'm not breaking any rules :)

Upon reading the docs, I've noticed that the methods get_versions and get_datasets are two methods that are essentially identical (even the description seems to be identical).

If I understand correctly, not only is this redundant but also somewhat confusing - neither method returns datasets nor versions but they both return List[DatasetVersion].

Maybe I've missed something and the functionality is in truth different?

IliaSmagloy avatar Jun 20 '22 11:06 IliaSmagloy

Hi @IliaSmagloy

Welcome here ! You are right, those two functions are the same. We introduced get_datasets in order to have a more explicit name - and we kept get_versions for compatibility reasons. Anyway, we will indicate that the functions are the same in the docs :)

The function returns a list of DatasetVersion because a Dataview can be composed of several datasets/versions of datasets.

DavidNativ avatar Jun 20 '22 15:06 DavidNativ

Does it answer to your questions ? I would also apreciate if you could close the thread. By the way, this is the GitHub for the opensource version, please contact the enterprise support for help/bug report or any feature request about a pro feature :) Thanks

DavidNativ avatar Jun 20 '22 16:06 DavidNativ