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

Import from hub docs #5631

Merged
merged 293 commits into from
Oct 30, 2024
Merged

Import from hub docs #5631

merged 293 commits into from
Oct 30, 2024

Conversation

nataliaElv
Copy link
Member

Description

Closes #<issue_number>

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactor (change restructuring the codebase without changing functionality)
  • Improvement (change adding some improvement to an existing functionality)
  • Documentation update

How Has This Been Tested

Checklist

  • I added relevant documentation
  • I followed the style guidelines of this project
  • I did a self-review of my code
  • I made corresponding changes to the documentation
  • I confirm My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/)

leiyre and others added 30 commits October 4, 2024 11:48
…eld to at least one field (required or not) (#5569)

# Description

In this PR we are changing how dataset publish validation works moving
from:
* At least one required field to be a valid publishable dataset.

To:

* At least one field (required or not) to be a valid publishable
dataset.

Refs argilla-io/roadmap#21

**Type of change**

- New feature (non-breaking change which adds functionality)


**How Has This Been Tested**

- [x] Modifying test suite. 

**Checklist**

- I added relevant documentation
- I followed the style guidelines of this project
- I did a self-review of my code
- I made corresponding changes to the documentation
- I confirm My changes generate no new warnings
- I have added tests that prove my fix is effective or that my feature
works
- I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)
# Description
<!-- Please include a summary of the changes and the related issue.
Please also include relevant motivation and context. List any
dependencies that are required for this change. -->

This PR removes name pattern validation for field, question,
metadata-property and vector-settings

**Type of change**
<!-- Please delete options that are not relevant. Remember to title the
PR according to the type of change -->

- Refactor (change restructuring the codebase without changing
functionality)
- Improvement (change adding some improvement to an existing
functionality)

**How Has This Been Tested**
<!-- Please add some reference about how your feature has been tested.
-->

**Checklist**
<!-- Please go over the list and make sure you've taken everything into
account -->

- I added relevant documentation
- I followed the style guidelines of this project
- I did a self-review of my code
- I made corresponding changes to the documentation
- I confirm My changes generate no new warnings
- I have added tests that prove my fix is effective or that my feature
works
- I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)
Copy link
Contributor

@burtenshaw burtenshaw left a comment

Choose a reason for hiding this comment

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

Looks pretty good.

This page is starting to get a lot of boxes. i.e. !!! note . When you read it on the frontend it's quite hard to follow. I would skim the page and see if some can be converted to in line text.

# Description
<!-- Please include a summary of the changes and the related issue.
Please also include relevant motivation and context. List any
dependencies that are required for this change. -->

This PR fixes problems when a class label sequence is mapped as
suggestions.

NOTE: This PR does not infer a sequence of class labels as multi-label
questions. Only prevent errors when a sequence of class labels column is
used as a suggestion (or other kinds of properties in argilla)

**Type of change**
<!-- Please delete options that are not relevant. Remember to title the
PR according to the type of change -->

- Bug fix (non-breaking change which fixes an issue)

**How Has This Been Tested**
<!-- Please add some reference about how your feature has been tested.
-->

**Checklist**
<!-- Please go over the list and make sure you've taken everything into
account -->

- I added relevant documentation
- I followed the style guidelines of this project
- I did a self-review of my code
- I made corresponding changes to the documentation
- I confirm My changes generate no new warnings
- I have added tests that prove my fix is effective or that my feature
works
- I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)
@nataliaElv nataliaElv requested a review from sdiazlor October 28, 2024 08:36
@nataliaElv
Copy link
Member Author

Looks pretty good.

This page is starting to get a lot of boxes. i.e. !!! note . When you read it on the frontend it's quite hard to follow. I would skim the page and see if some can be converted to in line text.

Solved!

Copy link
Contributor

@sdiazlor sdiazlor left a comment

Choose a reason for hiding this comment

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

Just some comments as a person with little knowledge of this feature and is taking a first look.

  • As the quickstart, I'd say to change the title of "Import a dataset from the Hub" to something more direct as it can be confusing for someone who doesn't know about Argilla. I'd say to use here "Create your first dataset", and that section remove it, adding just a note as Ben suggested and including SDK related stuff in a "Using the python SDK", similarly to "Deploy with Docker" where only it is mentioned and redirected. Or even combining the "importing long dataset" issue and the sdk further configuration/creation mention.
  • I'll move the image after Fields and Questions so people can understand what they see.
  • Not sure but regarding the Dataset Settings update, isn't it after giving it a name? I'd use a note or move it after that if that's the case.
  • About workspaces, I'd keep the "About workspaces" as it seems it must be manually added and it's not automatically inferred?
  • If this is the unique doc related to importing from the UI, it would be worthy to mention others like what about vectors or metadata, as those already knowing Argilla will have to check.

@nataliaElv nataliaElv marked this pull request as ready for review October 28, 2024 11:43
Base automatically changed from feat/create-dataset-from-ui to feat/argilla-direct-feature-branch October 29, 2024 09:02
@sdiazlor sdiazlor added this to the v2.4.0 milestone Oct 29, 2024
Base automatically changed from feat/argilla-direct-feature-branch to develop October 29, 2024 09:47
@frascuchon frascuchon changed the base branch from develop to releases/2.4.0 October 29, 2024 10:37
Copy link

Docs for this PR have been deployed hidden from versioning: https://docs.argilla.io/docs_ui-import-from-hub

@nataliaElv nataliaElv merged commit e8d1d22 into releases/2.4.0 Oct 30, 2024
7 checks passed
@nataliaElv nataliaElv deleted the docs/ui-import-from-hub branch October 30, 2024 14:52
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.

7 participants