docs: use kwargs with datasets (#3748) (#3749)

Arize-ai · Jun 29, 2024 · 599e340 · 599e340
1 parent 1cba50e
commit 599e340
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 11 deletions.
diff --git a/docs/datasets-and-experiments/how-to-datasets/creating-datasets.md b/docs/datasets-and-experiments/how-to-datasets/creating-datasets.md
@@ -32,8 +32,8 @@ dataset_df = pd.DataFrame(data={"query": queries, "responses": responses})
 px.launch_app()
 client = px.Client()
 dataset = client.upload_dataset(
-    dataset_df,
-    name="physics-questions",
+    dataframe=dataset_df,
+    dataset_name="physics-questions",
     input_keys=["query"],
     output_keys=["responses"],
 )
@@ -119,7 +119,7 @@ import phoenix as px
 # Note that the below code assumes that phoenix is running and accessible
 client = px.Client()
 client.upload_dataset(
-    questions_df, name="paul-graham-questions",
+    dataframe=questions_df, dataset_name="paul-graham-questions",
     input_keys=["question"],
     output_keys=["output"],
 )

diff --git a/docs/datasets-and-experiments/how-to-datasets/run-experiments.md b/docs/datasets-and-experiments/how-to-datasets/run-experiments.md
@@ -56,10 +56,10 @@ The dataframe can be sent to `Phoenix` via the `Client`. `input_keys` and `outpu
 import phoenix as px
 
 dataset = px.Client().upload_dataset(
-    df,
+    dataframe=df,
     input_keys=["question"],
     output_keys=[],
-    name="nba-questions",
+    dataset_name="nba-questions",
 )
 ```
 

diff --git a/docs/datasets-and-experiments/quickstart-datasets.md b/docs/datasets-and-experiments/quickstart-datasets.md
@@ -31,8 +31,8 @@ df = pd.DataFrame(
 )
 phoenix_client = px.Client()
 dataset = phoenix_client.upload_dataset(
-    df,
-    name="test-dataset",
+    dataframe=df,
+    dataset_name="test-dataset",
     input_keys=["question"],
     output_keys=["answer"],
     metadata_keys=["metadata"],

diff --git a/docs/datasets-and-experiments/use-cases-datasets/summarization.md b/docs/datasets-and-experiments/use-cases-datasets/summarization.md
@@ -85,10 +85,10 @@ df = (
 )
 now = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
 dataset = px.Client().upload_dataset(
-    df,
+    dataframe=df,
     input_keys=["article"],
     output_keys=["summary"],
-    name=f"news-article-summaries-{now}",
+    dataset_name=f"news-article-summaries-{now}",
 )
 ```
 

diff --git a/docs/datasets-and-experiments/use-cases-datasets/text2sql.md b/docs/datasets-and-experiments/use-cases-datasets/text2sql.md
@@ -136,10 +136,10 @@ Let's store the data above as a versioned dataset in phoenix.
 import pandas as pd
 
 ds = px.Client().upload_dataset(
-    pd.DataFrame([{"question": question} for question in questions]),
+    dataframe=pd.DataFrame([{"question": question} for question in questions]),
     input_keys=["question"],
     output_keys=[],
-    name="nba-questions",
+    dataset_name="nba-questions",
 )
 
 # If you have already uploaded the dataset, you can fetch it using the following line