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.

Sign up for GitHub

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 link to benchmark tutorial #295

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

add link to benchmark tutorial #295

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e987510
add link to benchmark tutorial
mschrimpf Jul 5, 2024
ce2a891
re-arrange tutorial links
mschrimpf Jul 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 36 additions & 26 deletions benchmarks/templates/benchmarks/tutorials/tutorial.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,39 +2,49 @@
{% load static %}

{% block banner %}
<h1>Tutorials</h1>
<p>Your one-stop-shop to get you up and running on Brain-Score in no time. </p>
<h1>Tutorials</h1>
<p>Your one-stop-shop to get you up and running on Brain-Score in no time. </p>
{% endblock %}

{% block info_section %}
{% include "benchmarks/tutorials/tutorial-info-section.html" %}
{% include "benchmarks/tutorials/tutorial-info-section.html" %}
{% endblock %}


{% block content %}
<div class="box leaderboard-table-component">
<div class="columns is-tablet is-variable is-1-tablet">
<div class="column is-one-half">
<img class="tutorial_main" src="{% static "/benchmarks/img/tutorials/tutorial_main.png" %}" />
</div>
<div class="column is-one-half tutorial_text">
<h3 class="benefits_heading is-size-3-mobile">Welcome!</h3>
<p class="benefits_info is-size-5-mobile">
We are excited that you are here. Below you will find guides and
links on various use cases of the platform. We hope that Brain-Score will enable you to find new
insights from models, benchmarks, and integrated scoring.
</p>
<p class="benefits_info is-size-5-mobile">
You can get up and running ASAP with our Quickstart, where you learn how to install Brain-Score on your
machine and how to score an existing model on an existing benchmark.
</p>
<p class="benefits_info is-size-5-mobile">
Or, if you are a more seasoned user, you can explore the platform further via our Deep Dive series. Here
there are guided overviews of the submission system, as well as instructions on how to submit plugins.
</p>
<a href="http{% if request.is_secure %}s{% endif %}://{{ request.get_host }}/tutorial/quickstart"><button class="button button-primary tutorial">Quickstart</button></a>
<a href="http{% if request.is_secure %}s{% endif %}://{{ request.get_host }}/tutorial/deepdive_1"><button class="button button-primary tutorial">Dive Deeper</button></a>
<div class="box leaderboard-table-component">
<div class="columns is-tablet is-variable is-1-tablet">
<div class="column is-one-half">
<img class="tutorial_main" src="{% static "/benchmarks/img/tutorials/tutorial_main.png" %}"/>
</div>
<div class="column is-one-half tutorial_text">
<h3 class="benefits_heading is-size-3-mobile">Welcome!</h3>
<p class="benefits_info is-size-5-mobile">
We are excited that you are here.
Below you will find guides and links on various use cases of the platform.
We hope that Brain-Score will enable you to
find new insights from models, benchmarks, and integrated scoring.
</p>
<p class="benefits_info is-size-5-mobile">
You can get up and running ASAP with our Quickstart, where you learn
how to install Brain-Score on your machine and
how to score an existing model on an existing benchmark.
</p>
<a href="http{% if request.is_secure %}s{% endif %}://{{ request.get_host }}/tutorial/quickstart">
<button class="button button-primary tutorial">Quickstart</button>
</a>
<p class="benefits_info is-size-5-mobile">
Or, if you are a more seasoned user, you can explore the platform further via our Deep Dive series.
This includes guided overviews of the submission system,
as well as instructions on how to submit model and benchmark plugins.
</p>
<a href="http{% if request.is_secure %}s{% endif %}://{{ request.get_host }}/tutorial/deepdive_1">
<button class="button button-primary tutorial">Model Deep Dive</button>
</a>
<a href="https://brain-score.readthedocs.io/en/latest/modules/benchmark_tutorial.html">
<button class="button button-primary tutorial">Benchmark Deep Dive</button>
</a>
</div>
</div>
</div>
</div>
{% endblock %}
19 changes: 12 additions & 7 deletions benchmarks/templates/benchmarks/tutorials/tutorial_quickstart.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,21 +118,26 @@ <h3 class="benefits_heading is-size-3-mobile">Further Learning Resources</h3>
<div class="columns is-tablet is-variable is-1-tablet">
<div class="column is-one-half tutorial_text">
<p class="benefits_info is-size-5-mobile shorter">
If you would like to know more about Brain-Score, please visit our Deep Dive series! These are guided tours
that walk you through how to put Brain-Score to work for you.
If you would like to know more about Brain-Score, please visit our Deep Dive series!
These are guided tours that walk you through how to put Brain-Score to work for you.
</p>
<p class="benefits_info is-size-5-mobile shorter">
In <a href="http{% if request.is_secure %}s{% endif %}://{{ request.get_host }}/tutorial/deepdive_1">Deep Dive 1</a>,
we will cover the submission package, and you can use this as a formatting guide for
we will cover the model submission package, and you can use this as a formatting guide for
your future submissions.
</p>
<p class="benefits_info is-size-5-mobile shorter">
In <a href="http{% if request.is_secure %}s{% endif %}://{{ request.get_host }}/tutorial/deepdive_2">Deep Dive 2</a>,
we will walkthough what a custom model submission looks like, and how to submit one.
we will walk through what a custom model submission looks like, and how to submit one.
</p>
<p class="benefits_info is-size-5-mobile shorter">
Finally, in <a href="http{% if request.is_secure %}s{% endif %}://{{ request.get_host }}/tutorial/deepdive_3">Deep Dive 3</a>,
we will cover how to submit a plugin via a Github Pull Request (PR).
In <a href="http{% if request.is_secure %}s{% endif %}://{{ request.get_host }}/tutorial/deepdive_3">Deep Dive 3</a>,
we will cover how to submit a model plugin via a Github Pull Request (PR).
</p>
<p class="benefits_info is-size-5-mobile shorter">
Finally, in the
<a href="https://brain-score.readthedocs.io/en/latest/modules/benchmark_tutorial.html">Benchmark Tutorial</a>,
we describe how to prepare data and stimuli for a benchmark submission.
</p>
</div>
<div class="column is-one-half">
Expand All @@ -141,7 +146,7 @@ <h3 class="benefits_heading is-size-3-mobile">Further Learning Resources</h3>
</div>
</div>
<div class="box leaderboard-table-component">
<h3 class="benefits_heading is-size-3-mobile">Optional: Scoring a Language Model</h3>
<h3 class="benefits_heading is-size-3-mobile">Scoring a Language Model</h3>
<p class="benefits_info is-size-5-mobile shorter">
The process is very similar for scoring a language model. First, install the needed packages in Step 1 above,
but just change all occurrences of vision to language, i.e:
Expand Down