tensorbay.client.search#
The structure of the search result.
- class tensorbay.client.search.SearchResultBase(job_id, search_result_id, search_result_commit_id, client)[source]#
Bases:
tensorbay.utility.repr.ReprMixin
This class defines the structure of the search result.
- Parameters
job_id (str) – The id of the search job.
search_result_id (str) – The id of the search result.
client (tensorbay.client.requests.Client) – The
Client
.search_result_commit_id (str) –
- Return type
None
- get_label_statistics()[source]#
Get label statistics of the search result.
- Returns
Required
Statistics
.- Return type
- class tensorbay.client.search.SearchResult(job_id, search_result_id, search_result_commit_id, client)[source]#
Bases:
tensorbay.client.search.SearchResultBase
This class defines the structure of the search result from normal dataset.
- Parameters
job_id (str) –
search_result_id (str) –
search_result_commit_id (str) –
client (tensorbay.client.requests.Client) –
- Return type
None
- list_data(segment_name)[source]#
List required data of the segment with given name.
- Parameters
segment_name (str) – Name of the segment.
- Returns
The PagingList of
RemoteData
.- Return type
tensorbay.client.lazy.PagingList[tensorbay.dataset.data.RemoteData]
- class tensorbay.client.search.FusionSearchResult(job_id, search_result_id, search_result_commit_id, client)[source]#
Bases:
tensorbay.client.search.SearchResultBase
This class defines the structure of the search result from fusion dataset.
- Parameters
job_id (str) –
search_result_id (str) –
search_result_commit_id (str) –
client (tensorbay.client.requests.Client) –
- Return type
None
- list_frames(segment_name)[source]#
List required frames of the segment with given name.
- Parameters
segment_name (str) – Name of the segment.
- Returns
The PagingList of
Frame
.- Return type
tensorbay.client.lazy.PagingList[tensorbay.dataset.frame.Frame]