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

proposal: Create a dedicated Github repository for Haystack demos #3695

Merged
merged 5 commits into from
Dec 22, 2022

Conversation

masci
Copy link
Contributor

@masci masci commented Dec 12, 2022

Related Issues

  • n/a

Proposed Changes:

NLP applications showcasing Haystack's capabilities can be an invaluable learning resource
for its users, but at this moment we don't fully take advantage of the only one demo we have
as a documentation source.

This proposal aims at overcoming that limitation in two ways:

  • Define better requirements for a demo application so that users can learn from it.
  • Make it easier to add more demo applications showcasing Haystack.

@masci masci self-assigned this Dec 12, 2022
@masci masci marked this pull request as ready for review December 12, 2022 11:04
@masci masci requested a review from a team as a code owner December 12, 2022 11:04
@masci masci requested review from bogdankostic and a team and removed request for a team December 12, 2022 11:04
Copy link
Member

@TuanaCelik TuanaCelik left a comment

Choose a reason for hiding this comment

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

All in all I love this proposal. As @bilgeyucel has been working on the REST API tutorial we've had the opportunity to learn a lot about how our demo + rest api works and currently the fact that the rest api and our own specific demo are so tightly bound to each other is not great from a developer experience imo. So this proposal is great.
I have one main open question about how we would move forward in technical terms about how the rest api would be spun up for each demo.


# How we teach this

Since we deem demo applications an important learning resource, in addition to the links pointing to
Copy link
Member

Choose a reason for hiding this comment

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

We could also think of how to communicate this on HSH

Copy link
Contributor

@bilgeyucel bilgeyucel Dec 12, 2022

Choose a reason for hiding this comment

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

Agree. Also, before we begin, we need to establish how we will differentiate demos from the concept of showcases that we were talking about.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@TuanaCelik I'll mention HSH but will stay generic to avoid any commitment in terms of delivery

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@bilgeyucel I don't want to derail the conversation too much, but if that helps - to me a "showcase" is a pointer to something cool made with Haystack. A demo might well be the subject of a showcase, but not necessarily.

proposals/text/3695-demo-repository.md Show resolved Hide resolved
Copy link
Contributor

@bilgeyucel bilgeyucel left a comment

Choose a reason for hiding this comment

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

I loved this idea! IMO, having a separate repo will make the demos more visible (we can directly share the link to the demo folder) and set the barrier lower for beginners to run them locally as there will be less distraction in terms of code 💯
I left two small comments about our approach, other than these, LGTM!

proposals/text/3695-demo-repository.md Show resolved Hide resolved
proposals/text/3695-demo-repository.md Outdated Show resolved Hide resolved
@masci masci added the proposal:review Proposal is in "Review" state label Dec 19, 2022
Copy link
Contributor

@bogdankostic bogdankostic left a comment

Choose a reason for hiding this comment

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

I very much like the idea of having a central place collecting all kinds of applications that can be built with Haystack!

I think this will allow us more effectively demonstrate all the potential use-cases that can be solved with Haystack and I hope we will see many contributions to learn how the community builds solutions using Haystack.

proposals/text/3695-demo-repository.md Outdated Show resolved Hide resolved
@masci masci added proposal:final-comment Proposal is in "Final Comment" state and removed proposal:review Proposal is in "Review" state labels Dec 19, 2022
@masci masci merged commit 2904587 into main Dec 22, 2022
@masci masci deleted the massi/demo-repo branch December 22, 2022 09:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
proposal:final-comment Proposal is in "Final Comment" state proposal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants