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

add benchmark versions #54

Merged
merged 4 commits into from
Nov 24, 2022
Merged

add benchmark versions #54

merged 4 commits into from
Nov 24, 2022

Conversation

carlosgauci
Copy link
Collaborator

Added versions to the Benchmarks page.

@vercel
Copy link

vercel bot commented Nov 20, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
haystack-home ✅ Ready (Inspect) Visit Preview Nov 24, 2022 at 0:23AM (UTC)

@carlosgauci carlosgauci linked an issue Nov 20, 2022 that may be closed by this pull request
@@ -3,4 +3,5 @@ layout: benchmarks
header: dark
footer: dark
title: Haystack Benchmarks
version: latest
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we maybe use a "real" version here? So that we don't need to have a latest folder that would be overwritten every time we add a new version

Copy link
Member

@TuanaCelik TuanaCelik Nov 21, 2022

Choose a reason for hiding this comment

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

Additionally to that, does it make sense to make the version number come up so that we can access the 'latest' version via it's version tag too? E.g. now it would be: https://haystack-home-git-benchmark-versions-deepset-overnice.vercel.app/benchmarks/v1.9.0
Which would also be accessible on https://haystack-home-git-benchmark-versions-deepset-overnice.vercel.app/benchmarks
And @masci do I understand correctly that here we would edit the _index.md file to include the actual latest version numner?
E.g.:

version: v1.9.0 --> this version becomes the one shown in .../benchmarks

{{ $retrieverPerformance := .Site.Data.benchmarks.retriever_performance }}
{{ $retrieverAccuracy := .Site.Data.benchmarks.retriever_map }}
{{ $retrieverSpeed := .Site.Data.benchmarks.retriever_speed }}
{{ $versions := (slice "v0.10.0" "v0.9.0" "v0.8.0" "v0.7.0" "v0.6.0" "v0.5.0" ) }}
Copy link
Member

Choose a reason for hiding this comment

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

Only if it's an easy fix, because it's quite a detail so no problem if not. If there's a way to automate this depending on what folders exist that would be nice. But as this won't be very frequent ok to keep this, let's just add instructions to the readme about how to add a new benchmark to the site.

@carlosgauci
Copy link
Collaborator Author

@masci @TuanaCelik I've updated it as requested, to add a new benchmark you can add a new markdown file for the page in the benchmarks folder, and update the version on the _index.md file so it will also be used on the /benchmarks page.

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.

This looks really good to me thanks @carlosgauci
From my side, let's merge the sitemap exclude PR first and update this one accordingly. Then I'm good with this to be merged :)
WDYT @masci ?

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.

Benchmarks page
3 participants