Skip to content

Commit 05a206d

Browse files
committed
Update prompt_response_projects.ipynb
1 parent c74e714 commit 05a206d

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

project_configuration/prompt_response_projects.ipynb

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
"metadata": {},
6464
"source": [
6565
"## API key and client\n",
66-
"Please provide a valid API key below to connect to the Labelbox client properly. For more information, please review the [Create API key guide](https://docs.labelbox.com/reference/create-api-key)."
66+
"Replace the value of `API_KEY` with a valid [API key]([ref:create-api-key](https://docs.labelbox.com/reference/create-api-key)) to connect to the Labelbox client."
6767
]
6868
},
6969
{
@@ -80,9 +80,9 @@
8080
"cell_type": "markdown",
8181
"metadata": {},
8282
"source": [
83-
"## Example: Create prompt response projects and ontologies\n",
83+
"## Example: Create prompt and response projects and ontologies\n",
8484
"\n",
85-
"The steps to creating prompt response projects and ontologies through the Labelbox-Python SDK are similar to creating a regular project. However, they vary slightly, and we will showcase the different methods in this example workflow."
85+
"The steps of creating prompt and response projects and corresponding ontologies using the Labelbox-Python SDK are similar to creating a regular project, and we will describe the slight differences for each scenario."
8686
]
8787
},
8888
{
@@ -91,7 +91,7 @@
9191
"source": [
9292
"### Create a prompt and response ontology\n",
9393
"\n",
94-
"You can create ontologies for prompt and response projects in the same way as other project ontologies using two methods: `client.create_ontology` and `client.create_ontology_from_feature_schemas`. For response creation projects the only difference between other projects is the media_type for the project needs to be set to `lb.MediaType.Text`. For prompt and prompt response creation projects you need to include their respective media type: `lb.MediaType.LLMPromptCreation` and `lb.MediaType.LLMPromptResponseCreation`. Additional you also need to provide an `ontology_kind` parameter, which needs to be set to `lb.OntologyKind.ResponseCreation` this is only applicable for prompt and prompt response creation projects."
94+
"You can create ontologies for prompt and response projects in the same way as other project ontologies using two methods: `client.create_ontology` and `client.create_ontology_from_feature_schemas`. You also need to include the respective `media_type`: `lb.MediaType.LLMPromptCreation` and `lb.MediaType.LLMPromptResponseCreation`. Additionally, you need to provide an `ontology_kind` parameter set to `lb.OntologyKind.ResponseCreation` that is only applicable for prompt and prompt response creation projects."
9595
]
9696
},
9797
{
@@ -100,9 +100,9 @@
100100
"source": [
101101
"#### Option A: `client.create_ontology`\n",
102102
"\n",
103-
"Typically, you create ontologies and generate the associated features simultaneously. Below is an example of creating an ontology for your prompt and response projects using supported classifications; for information on supported annotation types, visit our [prompt and response generation](https://docs.labelbox.com/docs/prompt-and-response-generation-editor) guide.\n",
103+
"Typically, you create ontologies and generate the associated features simultaneously. Below is an example of creating an ontology for your prompt and response projects using supported classifications; for information on supported annotation types, see [prompt and response generation](https://docs.labelbox.com/docs/prompt-and-response-generation-editor).\n",
104104
"\n",
105-
"Depending if you were creating a prompt, response, or prompt and response creation projects you would not need certain classifications inside your ontologies. For information on supported annotation types, visit our [prompt and response generation](doc:prompt-and-response-generation-editor#supported-prompt-formats) guide. In this notebook, we will be creating a prompt and response creation ontology. "
105+
"Depending if you were creating a prompt, response, or prompt and response creation projects, you don't need certain classifications inside your ontologies. For information on supported annotation types, see [prompt and response generation](doc:prompt-and-response-generation-editor#supported-prompt-formats). In this notebook, we will create a prompt and response creation ontology. "
106106
]
107107
},
108108
{
@@ -165,7 +165,7 @@
165165
"metadata": {},
166166
"source": [
167167
"### Option B: `client.create_ontology_from_feature_schemas`\n",
168-
"Ontologies can also be created with feature schema IDs. This makes your ontologies with existing features compared to generating new features. You can get these features by going to the _Schema_ tab inside Labelbox. (uncomment the below code block for this option)"
168+
"You can also create ontologies using feature schema IDs, which make your ontologies with existing features instead of generating new features. You can get these features by going to the _Schema_ tab inside Labelbox."
169169
]
170170
},
171171
{
@@ -174,6 +174,7 @@
174174
"metadata": {},
175175
"outputs": [],
176176
"source": [
177+
"# Uncomment the follwing code block for this option\n",
177178
"# ontology = client.create_ontology_from_feature_schemas(\n",
178179
"# \"LMC ontology\",\n",
179180
"# feature_schema_ids=[\"<list of feature schema ids\"],\n",
@@ -209,7 +210,7 @@
209210
"source": [
210211
"## Create prompt response and prompt creation projects\n",
211212
"\n",
212-
"When creating a prompt response or prompt creation project using client.create_prompt_response_generation_project, you do not need to create data rows because they are generated automatically. This method takes the same parameters as the traditional client.create_project but with a few specific additional parameters.\n",
213+
"When creating a prompt response or prompt creation project using `client.create_prompt_response_generation_project()`, you do not need to create data rows because they are generated automatically. This method takes the same parameters as the traditional client.create_project but with a few specific additional parameters.\n",
213214
"\n",
214215
"Parameters\n",
215216
"The `client.create_prompt_response_generation_project` method requires the following parameters:\n",

0 commit comments

Comments
 (0)