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: Custom Field outline #5536

Merged
merged 144 commits into from
Oct 3, 2024
Merged

Conversation

davidberenstein1957
Copy link
Member

Description

Closes NA

Type of change

  • Documentation update

How Has This Been Tested

Checklist

  • I added relevant documentation

jfcalvo and others added 30 commits July 19, 2024 16:30
…ine (#5355)

# 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 adds support to indexing datasets and records with image fields.

Note: A datasets reindex is required with this change.

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

- New feature (non-breaking change which adds 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/)
# 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 adds support to work with image fields using the SDK. 

## TODO (as separate PRs)

- [ ] Add documentation section
- [ ] Verify behavior using from/to_hub methods
- [ ] Add tooling to read data URLs from image files/folders (based on
logic defined in `image_to_html`)
- [ ] Add some media type validation (supported image types) 
- [ ] [Optional] Add tooling to re-scale images. The lower the image
sizes, the better the UI work. We can define a transparent re-scaling
process to support large images (currently the limit size in the backend
is 5MB for data URL)


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

- New feature (non-breaking change which adds 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/)

---------

Co-authored-by: José Francisco Calvo <[email protected]>
@burtenshaw burtenshaw added this to the v2.3.0 milestone Oct 1, 2024
Base automatically changed from feat/custom-field-support to develop October 2, 2024 12:14
@frascuchon frascuchon changed the base branch from develop to releases/2.3.0 October 3, 2024 08:08
@frascuchon frascuchon changed the base branch from releases/2.3.0 to develop October 3, 2024 08:08
@davidberenstein1957 davidberenstein1957 changed the base branch from develop to releases/2.3.0 October 3, 2024 08:37
…-field

# Conflicts:
#	argilla-frontend/CHANGELOG.md
#	argilla-server/src/argilla_server/search_engine/commons.py
@@ -662,7 +662,7 @@ def _build_text_query(dataset: Dataset, text: Optional[Union[TextQuery, str]] =
if field is None:
raise Exception(f"Field {text.field} not found in dataset {dataset.id}")

if field.is_chat:
if field.is_chat or field.is_custom:
Copy link
Member Author

Choose a reason for hiding this comment

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

@frascuchon should this be included in the release? perhaps we missed this initially?

@frascuchon frascuchon self-requested a review October 3, 2024 10:51
@davidberenstein1957 davidberenstein1957 merged commit 1e54a48 into releases/2.3.0 Oct 3, 2024
7 of 8 checks passed
@davidberenstein1957 davidberenstein1957 deleted the docs/custom-field branch October 3, 2024 11:15
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