docs: Documentation (#766)

* Update getting-started.md * Update llms.md * Update getting-started.md * Update getting-started.md * Update getting-started.md * Update getting-started.md * Update getting-started.md
sinaptik-ai · Nov 21, 2023 · a61a538 · a61a538
1 parent fa0b9d5
commit a61a538
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 12 deletions.
diff --git a/docs/LLMs/llms.md b/docs/LLMs/llms.md
@@ -178,7 +178,7 @@ langchain_llm = OpenAI(openai_api_key="my-openai-api-key")
 df = SmartDataframe("data.csv", {"llm": langchain_llm})
 ```
 
-PandasAI will automatically detect that you are using a LangChain llm and will convert it to a PandasAI llm.
+PandasAI will automatically detect that you are using a LangChain LLM and will convert it to a PandasAI LLM.
 
 ### More information
 

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -2,7 +2,7 @@
 
 ## Installation
 
-To use `pandasai`, first install it
+To use `pandasai`, first install it:
 
 ```console
 # Using poetry (recommended)
@@ -12,11 +12,11 @@ poetry add pandasai
 pip install pandasai
 ```
 
-> Before you install it, we recommended to create a Virtual environment using your preffred choice of Environment Managers e.g [Poetry](https://python-poetry.org/), [Pipenv](https://pipenv.pypa.io/en/latest/), [Conda](https://docs.conda.io/en/latest/), [Virtualenv](https://virtualenv.pypa.io/en/latest/), [Venv](https://docs.python.org/3/library/venv.html) etc.
+> Before installation, we recommend you create a virtual environment using your preferred choice of environment manager e.g [Poetry](https://python-poetry.org/), [Pipenv](https://pipenv.pypa.io/en/latest/), [Conda](https://docs.conda.io/en/latest/), [Virtualenv](https://virtualenv.pypa.io/en/latest/), [Venv](https://docs.python.org/3/library/venv.html) etc.
 
-### Optional Installs
+### Optional dependencies
 
-To keep the package size small, we have decided to make some dependencies that are not required by default. These dependencies are required for some features of `pandasai`. To install `pandasai` with these extra dependencies, run
+To keep the package size small, we have decided to make some dependencies optional. To install `pandasai` with these extra dependencies, run:
 
 ```console
 pip install pandasai[extra-dependency-name]
@@ -61,20 +61,20 @@ df.chat('Which are the 5 happiest countries?')
 # Output: United Kingdom, Canada, Australia, United States, Germany
 ```
 
-If you want to get to know more about the `SmartDataframe` class, check out this video:
+If you want to learn more about the `SmartDataframe` class, check out this video:
 
 [![Intro to SmartDataframe](https://cdn.loom.com/sessions/thumbnails/1ec1b8fbaa0e4ae0ab99b728b8b05fdb-00001.jpg)](https://www.loom.com/embed/1ec1b8fbaa0e4ae0ab99b728b8b05fdb?sid=7370854b-57c3-4f00-801b-69811a98d970 "Intro to SmartDataframe")
 
-### How to generate OpenAI API Token
+### How to generate an OpenAI API Token
 
-Users are required to generate `YOUR_API_TOKEN`. Follow below simple steps to generate your API_TOKEN with
+Users are required to generate `YOUR_API_TOKEN`. Follow these simple steps to generate `YOUR_API_TOKEN` with
 [openai](https://platform.openai.com/overview).
 
 1. Go to https://openai.com/api/ and signup with your email address or connect your Google Account.
-2. Go to View API Keys on left side of your Personal Account Settings
-3. Select Create new Secret key
+2. Go to View API Keys on left side of your Personal Account Settings.
+3. Select Create new Secret key.
 
-> The API access to openai is a paid service. You have to set up billing.
+> 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
@@ -106,7 +106,7 @@ df3 = "data/Loan payments data.xlsx"
 dl = SmartDatalake([df1, df2, df3])
 ```
 
-Then, you can use the `SmartDatalake` as follows, similar to how you would use a `SmartDataframe`:
+Then, similar to how you would use a `SmartDataframe`, you can use the `SmartDatalake` as follows:
 
 ```python
 dl.chat('Which are the 5 happiest countries?')