Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Juliagomes/update Installation section of readme #37

Merged
merged 2 commits into from
Aug 20, 2024
Merged

Juliagomes/update Installation section of readme #37

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9941b3d
Update Installation section of readme
Aug 20, 2024
d4b9640
Remove import
Aug 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,11 @@ We defer readers to the arxiv paper to see the effectiveness of these prompts ag

## Installation

```bash
$ guardrails hub install hub://arize/dataset_embeddings
```python
from guardrails import install
install("hub://arize-ai/dataset_embeddings_guardrails", quiet=True, install_local_models=True)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't look quite right. The validator is registered as arize/dataset_embeddings in the main.py file which typically means the hub id should be hub://arize/dataset_embeddings unless there are changes elsewhere I'm missing.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm in the Colab this seems to work

Screenshot 2024-08-19 at 7 06 13 PM

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The other version throws an error

Screenshot 2024-08-19 at 7 07 11 PM

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There may be a discrepancy between this and the hub index, let me check

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, sure enough this is the id listed in the hub index. It's not the normal pattern but it should work.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, let me know if anything needs to be updated on my side!


from guardrails.hub import ArizeDatasetEmbeddings
```

## Usage Examples
Expand Down
Loading