Skip to content

Add Jupyter Notebook/Use-Cases Section under Tutorial #385

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

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

Add Jupyter Notebook/Use-Cases Section under Tutorial #385

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
37e48c6
Add starter template for use cases and fix sidebar links to function …
KartikP Mar 29, 2025
41e91a1
Merge branch 'master' into kp/use-cases-notebooks
KartikP Jun 3, 2025
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
19 changes: 11 additions & 8 deletions benchmarks/templates/benchmarks/components/left-sidebar.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,21 +29,24 @@
</a>
<div class="dropdown-content">
<div class="nested-dropdown">
<a href="https://www.brain-score.org/tutorials/models">Models</a>
<a href="http{% if request.is_secure %}s{% endif %}://{{ request.get_host }}/tutorials/models">Models</a>
<div class="nested-dropdown-content">
<a href="https://www.brain-score.org/tutorials/models/quickstart">Quickstart</a>
<a href="https://www.brain-score.org/tutorials/models/deepdive_1">Deep Dive 1</a>
<a href="https://www.brain-score.org/tutorials/models/deepdive_2">Deep Dive 2</a>
<a href="https://www.brain-score.org/tutorials/models/deepdive_3">Deep Dive 3</a>
<a href="http{% if request.is_secure %}s{% endif %}://{{ request.get_host }}/tutorials/models/quickstart">Quickstart</a>
<a href="http{% if request.is_secure %}s{% endif %}://{{ request.get_host }}/tutorials/models/deepdive_1">Deep Dive 1</a>
<a href="http{% if request.is_secure %}s{% endif %}://{{ request.get_host }}/tutorials/models/deepdive_2">Deep Dive 2</a>
<a href="http{% if request.is_secure %}s{% endif %}://{{ request.get_host }}/tutorials/models/deepdive_3">Deep Dive 3</a>
</div>
</div>
<div class="nested-dropdown">
<a href="https://www.brain-score.org/tutorials/benchmarks">Benchmarks</a>
<a href="http{% if request.is_secure %}s{% endif %}://{{ request.get_host }}/tutorials/benchmarks">Benchmarks</a>
<div class="nested-dropdown-content">
<a href="https://www.brain-score.org/tutorials/benchmarks/package_data">Package Data</a>
<a href="https://www.brain-score.org/tutorials/benchmarks/create_benchmark">Create Benchmark</a>
<a href="http{% if request.is_secure %}s{% endif %}://{{ request.get_host }}/tutorials/benchmarks/package_data">Package Data</a>
<a href="http{% if request.is_secure %}s{% endif %}://{{ request.get_host }}/tutorials/benchmarks/create_benchmark">Create Benchmark</a>
</div>
</div>
<div class="nested-dropdown">
<a href="http{% if request.is_secure %}s{% endif %}://{{ request.get_host }}/tutorials/use-cases/use-cases">Use Cases</a>
</div>
</div>
</div>

Expand Down
2 changes: 2 additions & 0 deletions benchmarks/templates/benchmarks/tutorials/tutorial.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ <h3 class="benefits_heading is-size-3-mobile">Welcome!</h3>
</p>
<a href="http{% if request.is_secure %}s{% endif %}://{{ request.get_host }}/tutorials/models"><button class="button button-primary tutorial">Models</button></a>
<a href="http{% if request.is_secure %}s{% endif %}://{{ request.get_host }}/tutorials/benchmarks"><button class="button button-primary tutorial">Benchmarks</button></a>
<a href="http{% if request.is_secure %}s{% endif %}://{{ request.get_host }}/tutorials/use-cases/use-cases"><button class="button button-primary tutorial">Use Cases</button></a>

</div>
</div>
</div>
Expand Down
96 changes: 96 additions & 0 deletions benchmarks/templates/benchmarks/tutorials/use-cases/use-cases.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
{% extends "benchmarks/components/app-view.html" %}
{% load static %}

{% block banner %}
<h1>Use Cases</h1>
<p>
Below you will find a curated set of examples notebooks demonstrating typical Brain-Score use cases,
available as Jupyter Notebooks. To ensure they are always up to date, the notebooks are maintained
in our <a href="https://github.com/brain-score/vision/examples">vision</a> repository. Each link
below will take you directly to the latest version on GitHub.
</p>
{% endblock %}



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


{% block content %}
<div class="box leaderboard-table-component">
<h3 class="benefits_heading is-size-3-mobile">Scoring Models</h3>
<p class="benefits_info is-size-5-mobile shorter">
Score models locally on public benchmarks.
</p>
<button class="button">
<a href="test_link" target="_blank">
<i class="fas fa-file-alt"></i> View Notebook on GitHub
</a>
</button>
</div>

<div class="box leaderboard-table-component">
<h3 class="benefits_heading is-size-3-mobile">Perform Region-Layer Mapping</h3>
<p class="benefits_info is-size-5-mobile shorter">
Region-Layer Mapping is a fundamental step in converting a BaseModel into a Brain-Score model.
Here, `get_layers`are benchmarked against `STANDARD_REGION_BENCHMARKS` and subsequently
committed to a specific region.
</p>
<button class="button">
<a href="test_link" target="_blank">
<i class="fas fa-file-alt"></i> View Notebook on GitHub
</a>
</button>
</div>

<div class="box leaderboard-table-component">
<h3 class="benefits_heading is-size-3-mobile">Explore Neural Benchmarks</h3>
<p class="benefits_info is-size-5-mobile shorter">

</p>
<button class="button">
<a href="test_link" target="_blank">
<i class="fas fa-file-alt"></i> View Notebook on GitHub
</a>
</button>
</div>

<div class="box leaderboard-table-component">
<h3 class="benefits_heading is-size-3-mobile">Explore Behavioral Benchmarks</h3>
<p class="benefits_info is-size-5-mobile shorter">

</p>
<button class="button">
<a href="test_link" target="_blank">
<i class="fas fa-file-alt"></i> View Notebook on GitHub
</a>
</button>
</div>

<div class="box leaderboard-table-component">
<h3 class="benefits_heading is-size-3-mobile">Creating Neural Benchmarks</h3>
<p class="benefits_info is-size-5-mobile shorter">

</p>
<button class="button">
<a href="test_link" target="_blank">
<i class="fas fa-file-alt"></i> View Notebook on GitHub
</a>
</button>
</div>

<div class="box leaderboard-table-component">
<h3 class="benefits_heading is-size-3-mobile">Creating Behavioral Benchmarks</h3>
<p class="benefits_info is-size-5-mobile shorter">

</p>
<button class="button">
<a href="test_link" target="_blank">
<i class="fas fa-file-alt"></i> View Notebook on GitHub
</a>
</button>
</div>

{% endblock %}
3 changes: 3 additions & 0 deletions benchmarks/urls.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,9 @@
path('tutorials/benchmarks/create_benchmark',
user.Tutorials.as_view(plugin="benchmarks", tutorial_type="create_benchmark"),
name='benchmark-create-benchmark'),
# - use case tutorials
path('tutorials/use-cases/use-cases', user.Tutorials.as_view(tutorial_type="use-cases/use-cases"), name='use-case-tutorial'),

# - brain model explanation
path('brain_model', brain_model.view, name='brain-model'),

Expand Down
11 changes: 8 additions & 3 deletions static/benchmarks/css/components/left-sidebar.sass
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
left: 0
padding-right: 0
background: $brainscore_gray4
z-index: 9998

a
display: block
Expand Down Expand Up @@ -51,15 +52,17 @@
background-color: white
min-width: 160px
box-shadow: 0px 8px 16px rgba(0,0,0,0.2)
z-index: 1
transform: translateX(67px)
z-index: 9999
left: 67px
top: 100%

// Dropdown links styling
.dropdown-content a
color: black
padding: 12px 16px
text-decoration: none
display: block
z-index: 9999

.dropdown:hover > .dropdown-content
display: block
Expand All @@ -81,10 +84,12 @@
background-color: white
width: 180px
box-shadow: 0px 8px 16px rgba(0,0,0,0.2)
z-index: 1
z-index: 10000


.nested-dropdown-content a
font-size: 0.9em
z-index: 10000

// Show nested dropdown on hover
.nested-dropdown:hover .nested-dropdown-content
Expand Down