search

allegroai / clearml

ClearML - Auto-Magical CI/CD to streamline your AI workload. Experiment Management, Data Management, Pipeline, Orchestration, Scheduling & Serving in one MLOps/LLMOps solution
https://clear.ml/docs
Apache License 2.0
5.69k stars 655 forks source link

Task.query_tasks needs to be elaboration #981

Closed Make42 closed 1 year ago

Make42 commented 1 year ago

https://clear.ml/docs/latest/docs/references/sdk/task/#taskquery_tasks mentions "service.tasks.GetAllRequest", but I cannot find where or what that is. Why I can find tasks.GetAllRequest mentioned in the code, this does not explain much and I am not able to find the actual tasks.GetAllRequest. What is tasks.GetAllRequest? Also, I think the respective documentation / docstring should be elaborated.

ainoam commented 1 year ago

Hi @Make42,

Indeed the target reference is somewhat ambiguous.

Looking around the page, you'd notice that GetAllRequest refers to the backend API which is implemented for multiple API versions e.g. backend_api.services.v2_23.tasks.GetAllRequest, which elaborates on the available options.

We'll clarify where this is missing.

Make42 commented 1 year ago

@ainoam:

We'll clarify where this is missing.

Thank you! I am sure, am not the only one to not have the idea to search for the term on the page :-)

Make42 commented 1 year ago

I made pull request https://github.com/allegroai/clearml/pull/982

ainoam commented 1 year ago

Many Many thanks!