Skip to content

Commit

Permalink
Docs / Fix typos (#19)
Browse files Browse the repository at this point in the history
Fix README typos
  • Loading branch information
nimbusaeta authored Mar 12, 2024
1 parent 14d096a commit f56711e
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

# PromptMeteo 🔥🧔

**Promptmeteo** is a Python library for Prompt Engineering built over LangChain. It simplifies the utilization of Language Model Models (LLMs) for various tasks through a low-code interface. To achieve this, Promptmeteo can employ different LLM models and dynamically generate prompts for specific tasks based on just a few configuration parameters.
**Promptmeteo** is a Python library for prompt engineering built over LangChain. It simplifies the utilization of large language models (LLMs) for various tasks through a low-code interface. To achieve this, Promptmeteo can employ different LLM models and dynamically generate prompts for specific tasks based on just a few configuration parameters.



Expand Down Expand Up @@ -35,7 +35,7 @@ Promptmeteo aims to address the aforementioned issues by dividing the prompt def

#### 🏠 Prebuilt tasks

The project incorporates high-level objects designed to address various NLP tasks, including text classification, Named Entity Recognition, and code generation. These objects only require configuration parameters for execution, eliminating the need to parse the output from the Language Model Models (LLMs).
The project incorporates high-level objects designed to address various NLP tasks, including text classification, named entity recognition, and code generation. These objects only require configuration parameters for execution, eliminating the need to parse the output from the LLMs.

#### ⚙️ Ease of Deployment

Expand Down Expand Up @@ -109,7 +109,7 @@ clf.predict(['so cool!!'])
```

### ✨ Train the task
Buy you can also include examples to improve the results by calling the method `train()`
But you can also include examples to improve the results by calling the method `train()`.


```python
Expand All @@ -127,7 +127,7 @@ clf.predict(['so cool!!'])

### ✨ Save a trained task

One the model is trained it can be saved locally
Once the model is trained it can be saved locally...

```python
clf.save_model("hello_world.meteo")
Expand All @@ -136,7 +136,7 @@ clf.save_model("hello_world.meteo")

### ✨ Load a trained task

and loaded again to make new predictions
... and loaded again to make new predictions.

```python
from promptmeteo import DocumentClassifier
Expand All @@ -154,7 +154,7 @@ clf.predict(['so cool!!'])
[['positive']]
```

Models can also be loaded without instantiating the class by using load_model as a function instead of a method:
Models can also be loaded without instantiating the class by using `load_model()` as a function instead of a method:

```python
from promptmeteo import DocumentClassifier
Expand All @@ -172,7 +172,7 @@ More examples can be seen in the directory [examples](./examples).
## 🚗 Usage

### ⚙️ Configure credentials
Create a ```.env``` with the following variables depending on the LLM provider
Create a ```.env``` with the following variables depending on the LLM provider.

#### Google Cloud
First you should create a [Service Account](https://cloud.google.com/vertex-ai/docs/general/custom-service-account#configure) with the role: ``Vertex AI User.``
Expand Down

0 comments on commit f56711e

Please sign in to comment.