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.

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

Juliagomes/update Installation section of readme #37

Merged
merged 2 commits into from
Aug 20, 2024

Conversation

jgomes168
Copy link
Collaborator

Update installation section of README to avoid errors.

Successful installation in Colab notebook:
Screenshot 2024-08-19 at 6 49 00 PM

Failed installation in Colab notebook:
Screenshot 2024-08-19 at 6 49 58 PM

$ 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)

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

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

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!

@jgomes168 jgomes168 merged commit 8293751 into main Aug 20, 2024
1 check failed
@jgomes168 jgomes168 deleted the juliagomes/update-readme-installation branch August 20, 2024 02:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants