Skip to content

Commit cd5567f

Browse files
author
Val Brodsky
committed
Update rdoc
1 parent 1ada7be commit cd5567f

File tree

1 file changed

+9
-14
lines changed

1 file changed

+9
-14
lines changed

libs/labelbox/src/labelbox/client.py

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -619,27 +619,21 @@ def create_project(
619619
name="<project_name>",
620620
description="<project_description>",
621621
media_type=MediaType.Image,
622-
queue_mode=QueueMode.Batch
623622
)
624623
625624
Args:
626625
name (str): A name for the project
627626
description (str): A short summary for the project
628627
media_type (MediaType): The type of assets that this project will accept
629628
queue_mode (Optional[QueueMode]): The queue mode to use
630-
quality_mode (Optional[QualityMode]): The quality mode to use (e.g. Benchmark, Consensus). Defaults to
631-
Benchmark
632629
quality_modes (Optional[List[QualityMode]]): The quality modes to use (e.g. Benchmark, Consensus). Defaults to
633630
Benchmark.
631+
is_benchmark_enabled (Optional[bool]): Whether the project supports benchmark. Defaults to None.
632+
is_consensus_enabled (Optional[bool]): Whether the project supports consensus. Defaults to None.
634633
Returns:
635634
A new Project object.
636635
Raises:
637-
InvalidAttributeError: If the Project type does not contain
638-
any of the attribute names given in kwargs.
639-
640-
NOTE: the following attributes are used only in chat model evaluation projects:
641-
dataset_name_or_id, append_to_existing_dataset, data_row_count, editor_task_type
642-
They are not used for general projects and not supported in this method
636+
ValueError: If inputs are invalid.
643637
"""
644638
input = {
645639
"name": name,
@@ -675,12 +669,12 @@ def create_model_evaluation_project(
675669
dataset_name: When creating a new dataset, pass the name
676670
dataset_id: When using an existing dataset, pass the id
677671
data_row_count: The number of data row assets to use for the project
678-
**kwargs: Additional parameters to pass to the the create_project method
672+
See create_project for additional parameters
679673
Returns:
680674
Project: The created project
681675
682676
Examples:
683-
>>> client.create_model_evaluation_project(name=project_name, dataset_name="new data set")
677+
>>> client.create_model_evaluation_project(name=project_name, media_type=dataset_name="new data set")
684678
>>> This creates a new dataset with a default number of rows (100), creates new project and assigns a batch of the newly created datarows to the project.
685679
686680
>>> client.create_model_evaluation_project(name=project_name, dataset_name="new data set", data_row_count=10)
@@ -741,7 +735,7 @@ def create_offline_model_evaluation_project(
741735
"""
742736
Creates a project for offline model evaluation.
743737
Args:
744-
**kwargs: Additional parameters to pass see the create_project method
738+
See create_project for parameters
745739
Returns:
746740
Project: The created project
747741
"""
@@ -782,7 +776,8 @@ def create_prompt_response_generation_project(
782776
dataset_name: When creating a new dataset, pass the name
783777
dataset_id: When using an existing dataset, pass the id
784778
data_row_count: The number of data row assets to use for the project
785-
**kwargs: Additional parameters to pass see the create_project method
779+
media_type: The type of assets that this project will accept. Limited to LLMPromptCreation and LLMPromptResponseCreation
780+
See create_project for additional parameters
786781
Returns:
787782
Project: The created project
788783
@@ -858,7 +853,7 @@ def create_response_creation_project(
858853
"""
859854
Creates a project for response creation.
860855
Args:
861-
**kwargs: Additional parameters to pass see the create_project method
856+
See create_project for parameters
862857
Returns:
863858
Project: The created project
864859
"""

0 commit comments

Comments
 (0)