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

Re-design primitives #1232

Closed
tholor opened this issue Jun 28, 2021 · 2 comments
Closed

Re-design primitives #1232

tholor opened this issue Jun 28, 2021 · 2 comments
Assignees

Comments

@tholor
Copy link
Member

tholor commented Jun 28, 2021

Let's re-think what core data types / primitives we need in Haystack and how we want to structure them (attributes, methods, types ...).

As of now, we have in schema.py:

  • Document
  • Label
  • MultiLabel

In addition, we use in the REST API:

  • Answer
  • Request
  • Response

What we should do:

  • Let's discuss if we need more primitives (in the past we thought about splitting Label into multiple classes for QA / Retrieval; we also want to have "standardized" input / output objects for pipeline nodes)
  • Let's examine if the current primitives need any refactoring (e.g. attribute names, redundancies ...)
  • Let's document all primitives

Related to:

  • Will help to standardize input/outputs of pipelines and therefore enable validation of pipelines (Validation of search Pipeline graph #600)
  • Will help to standardize request and response types in REST API for different pipeline types
  • Might simplify evaluation of different pipelines types
  • Might be needed to store labels for other pipeline types
@brandenchan
Copy link
Contributor

Am very much in favor of this! Please keep me in the loop with progress so we can make sure we have this well documented

@tholor
Copy link
Member Author

tholor commented Oct 13, 2021

Implemented in #1398

@tholor tholor closed this as completed Oct 13, 2021
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

No branches or pull requests

3 participants