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

docs: add from diskto disk methods to docs #5186

Closed

Conversation

sdiazlor
Copy link
Contributor

@sdiazlor sdiazlor commented Jul 9, 2024

Pull Request Template

Closes #5178

Type of change

  • Documentation update

How Has This Been Tested

Checklist

  • I added relevant documentation

Copy link

github-actions bot commented Jul 9, 2024

Docs for this PR have been deployed hidden from versioning: https://argilla-io.github.io/argilla/docs_5178-docs-add-from_diskto_disk-methods-to-docs

@davidberenstein1957
Copy link
Member

@sdiazlor, looking good. Would you be able to review the line length of code in guides too? sometimes it isn't easy to read because lines are too long. Also, along with the release of the from_hub and to_hub methods, I think we should try to generalize the headers a bit more and add the different ways to load en save datasets in different tabs.


dataset_to_save = client.datasets(name="my_dataset")

dataset_saved = dataset_to_save.to_disk(path="/path/empty-directory")
Copy link
Member

Choose a reason for hiding this comment

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

What does to_disk() returns? I'd use a more precise name for the variable and even add a sentence in the description on top about it. I also think is worth mentioning that we recommend creating an empty directory

Copy link
Member

@dvsrepo dvsrepo left a comment

Choose a reason for hiding this comment

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

just a small comment

Copy link
Member

@davidberenstein1957 davidberenstein1957 left a comment

Choose a reason for hiding this comment

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

see earlier comment

@sdiazlor sdiazlor closed this Jul 11, 2024
@sdiazlor sdiazlor deleted the docs/5178-docs-add-from_diskto_disk-methods-to-docs branch July 29, 2024 09:42
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.

3 participants