Skip to content

Commit

Permalink
docs: add reference on how to instantiate a sdf with name and desc
Browse files Browse the repository at this point in the history
  • Loading branch information
gventuri committed Nov 10, 2023
1 parent 224ad1c commit 96db387
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,15 @@ Users are required to generate `YOUR_API_TOKEN`. Follow below simple steps to ge
> The API access to openai is a paid service. You have to set up billing.
> Read the [Pricing](https://platform.openai.com/docs/quickstart/pricing) information before experimenting.
### Passing name and description

Sometimes, to help the LLM to work better, you might want to pass a name and a description of the dataframe.
You can do so as follows:

```python
df = SmartDataframe(df, name="My DataFrame", description="This is my DataFrame")
```

## SmartDatalake

PandasAI also supports queries with multiple dataframes. To perform such queries, you can use a `SmartDatalake` instead of a `SmartDataframe`. A `SmartDatalake` is a collection of `SmartDataframe`s. You can instantiate a `SmartDatalake` as follows:
Expand Down

0 comments on commit 96db387

Please sign in to comment.