Skip to content

Commit

Permalink
Update styling of docs (#253)
Browse files Browse the repository at this point in the history
  • Loading branch information
@seyuboglu
seyuboglu authored Jul 22, 2022
1 parent e2fef82 commit 2be1209
Show file tree
Hide file tree
Showing 4 changed files with 109 additions and 28 deletions.
7 changes: 7 additions & 0 deletions docs/source/_static/css/custom.css
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
html[data-theme="light"] {
/*****************************************************************************
* main colors
*/
--pst-color-primary: rgb(19,7,83);
--pst-color-secondary: rgb(252,177,62);
}
6 changes: 5 additions & 1 deletion docs/source/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,11 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = []
html_static_path = ["_static"]

html_css_files = [
"css/custom.css",
]

# Don't show module names in front of class names.
add_module_names = False
Expand Down
4 changes: 2 additions & 2 deletions docs/source/datasets/datasets.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ By default datasets are downloaded to ``~/.meerkat/datasets/{name}/{version}``.
dp = mk.datasets.get("imagenette", dataset_dir="/local/download/of/imagenette/full")
You can also configure Meerkat to use a different default root directory. By setting the ``mk.config.root_dir = "/local/download/of"``, the default location for datasets will be ``/local/download/of/datasets/{name}/{version}``.
You can also configure Meerkat to use a different default root directory. By setting the ``mk.config.datasets.root_dir = "/local/download/of"``, the default location for datasets will be ``/local/download/of/datasets/{name}/{version}``.

*How does Meerkat's dataset registry fit in with other dataset hubs?* The purpose of the Meerkat dataset registry is to provide *code* for downloading datasets and loading them into :class:`~meerkat.DataPanel` objects. The Meerkat registry, like `Torchvision Datasets <https://pytorch.org/vision/stable/datasets.html>`_, doesn't actually host any data.
In contrast, dataset hubs like `HuggingFace Datasets <https://huggingface.co/docs/datasets/index>`_ and `Activeloop Hub <https://www.activeloop.ai/>`_ are great community efforts that *do* host data. So, the Meerkat registry is complementary to these hubs: in fact, we can currently load any dataset in the HuggingFace hubs directly through our registry. For example, we can load the `IMBD dataset <https://huggingface.co/datasets/imdb>`_ hosted on HuggingFace with ``mk.datasets.get("imdb")``.
Expand All @@ -37,7 +37,7 @@ In contrast, dataset hubs like `HuggingFace Datasets <https://huggingface.co/doc


The table below lists all of the datasets currently in the meerkat registry.
You can also list these datasets programmatically :func:`~meerkat.datasets.catalog`.
You can also list these datasets programmatically with ``mk.datasets.catalog``.


.. raw:: html
Expand Down
120 changes: 95 additions & 25 deletions docs/source/datasets/datasets_table.html
View file
Original file line number Diff line number Diff line change
@@ -1,87 +1,157 @@
<style type="text/css">
#T_83701 .col-1 {
#T_9ab09 .col-1 {
max-width: 50%;
}
</style>
<table id="T_83701">
<table id="T_9ab09">
<thead>
<tr>
<th class="blank level0" >&nbsp;</th>
<th id="T_83701_level0_col0" class="col_heading level0 col0" >tags</th>
<th id="T_83701_level0_col1" class="col_heading level0 col1" >versions</th>
<th id="T_83701_level0_col2" class="col_heading level0 col2" >homepage</th>
<th id="T_9ab09_level0_col0" class="col_heading level0 col0" >tags</th>
<th id="T_9ab09_level0_col1" class="col_heading level0 col1" >versions</th>
<th id="T_9ab09_level0_col2" class="col_heading level0 col2" >homepage</th>
</tr>
</thead>
<tbody>
<tr>
<th id="T_83701_level0_row0" class="row_heading level0 row0" >celeba</th>
<td id="T_83701_row0_col0" class="data row0 col0" >
<th id="T_9ab09_level0_row0" class="row_heading level0 row0" >celeba</th>
<td id="T_9ab09_row0_col0" class="data row0 col0" >
<div class='tags'>
<div class='tag'>image</div><div class='tag'>face recognition</div>
</div>
</td>
<td id="T_83701_row0_col1" class="data row0 col1" >
<td id="T_9ab09_row0_col1" class="data row0 col1" >
<div class='versions'>
<div class='tag'>main</div>
</div>
</td>
<td id="T_83701_row0_col2" class="data row0 col2" ><a href="https://mmlab.ie.cuhk.edu.hk/projects/CelebA.html">link</a></td>
<td id="T_9ab09_row0_col2" class="data row0 col2" ><a href="https://mmlab.ie.cuhk.edu.hk/projects/CelebA.html">link</a></td>
</tr>
<tr>
<th id="T_83701_level0_row1" class="row_heading level0 row1" >imagenet</th>
<td id="T_83701_row1_col0" class="data row1 col0" >
<th id="T_9ab09_level0_row1" class="row_heading level0 row1" >coco</th>
<td id="T_9ab09_row1_col0" class="data row1 col0" >
<div class='tags'>
<div class='tag'>image</div><div class='tag'>object recognition</div>
</div>
</td>
<td id="T_9ab09_row1_col1" class="data row1 col1" >
<div class='versions'>
<div class='tag'>2014</div>
</div>
</td>
<td id="T_9ab09_row1_col2" class="data row1 col2" ><a href="https://cocodataset.org/#home">link</a></td>
</tr>
<tr>
<th id="T_9ab09_level0_row2" class="row_heading level0 row2" >expw</th>
<td id="T_9ab09_row2_col0" class="data row2 col0" >
<div class='tags'>
<div class='tag'>image</div><div class='tag'>classification</div>
</div>
</td>
<td id="T_9ab09_row2_col1" class="data row2 col1" >
<div class='versions'>
<div class='tag'>main</div>
</div>
</td>
<td id="T_9ab09_row2_col2" class="data row2 col2" ><a href="https://github.com/fastai/imagenette">link</a></td>
</tr>
<tr>
<th id="T_9ab09_level0_row3" class="row_heading level0 row3" >fer</th>
<td id="T_9ab09_row3_col0" class="data row3 col0" >
<div class='tags'>
<div class='tag'>image</div><div class='tag'>facial emotion recognition</div>
</div>
</td>
<td id="T_9ab09_row3_col1" class="data row3 col1" >
<div class='versions'>
<div class='tag'>plus</div>
</div>
</td>
<td id="T_9ab09_row3_col2" class="data row3 col2" ><a href="https://www.kaggle.com/c/challenges-in-representation-learning-facial-expression-recognition-challenge/data?select=icml_face_data.csv">link</a></td>
</tr>
<tr>
<th id="T_9ab09_level0_row4" class="row_heading level0 row4" >imagenet</th>
<td id="T_9ab09_row4_col0" class="data row4 col0" >
<div class='tags'>
<div class='tag'>image</div><div class='tag'>classification</div>
</div>
</td>
<td id="T_83701_row1_col1" class="data row1 col1" >
<td id="T_9ab09_row4_col1" class="data row4 col1" >
<div class='versions'>
<div class='tag'>ilsvrc2012</div>
</div>
</td>
<td id="T_83701_row1_col2" class="data row1 col2" ><a href="https://www.image-net.org/">link</a></td>
<td id="T_9ab09_row4_col2" class="data row4 col2" ><a href="https://www.image-net.org/">link</a></td>
</tr>
<tr>
<th id="T_83701_level0_row2" class="row_heading level0 row2" >imagenette</th>
<td id="T_83701_row2_col0" class="data row2 col0" >
<th id="T_9ab09_level0_row5" class="row_heading level0 row5" >imagenette</th>
<td id="T_9ab09_row5_col0" class="data row5 col0" >
<div class='tags'>
<div class='tag'>image</div><div class='tag'>classification</div>
</div>
</td>
<td id="T_83701_row2_col1" class="data row2 col1" >
<td id="T_9ab09_row5_col1" class="data row5 col1" >
<div class='versions'>
<div class='tag'>full</div><div class='tag'>320px</div><div class='tag'>160px</div>
</div>
</td>
<td id="T_83701_row2_col2" class="data row2 col2" ><a href="https://github.com/fastai/imagenette">link</a></td>
<td id="T_9ab09_row5_col2" class="data row5 col2" ><a href="https://github.com/fastai/imagenette">link</a></td>
</tr>
<tr>
<th id="T_83701_level0_row3" class="row_heading level0 row3" >mirflickr</th>
<td id="T_83701_row3_col0" class="data row3 col0" >
<th id="T_9ab09_level0_row6" class="row_heading level0 row6" >mirflickr</th>
<td id="T_9ab09_row6_col0" class="data row6 col0" >
<div class='tags'>
<div class='tag'>image</div><div class='tag'>retrieval</div>
</div>
</td>
<td id="T_83701_row3_col1" class="data row3 col1" >
<td id="T_9ab09_row6_col1" class="data row6 col1" >
<div class='versions'>
<div class='tag'>25k</div>
</div>
</td>
<td id="T_83701_row3_col2" class="data row3 col2" ><a href="https://press.liacs.nl/mirflickr/">link</a></td>
<td id="T_9ab09_row6_col2" class="data row6 col2" ><a href="https://press.liacs.nl/mirflickr/">link</a></td>
</tr>
<tr>
<th id="T_9ab09_level0_row7" class="row_heading level0 row7" >ngoa</th>
<td id="T_9ab09_row7_col0" class="data row7 col0" >
<div class='tags'>
<div class='tag'>art</div>
</div>
</td>
<td id="T_9ab09_row7_col1" class="data row7 col1" >
<div class='versions'>
<div class='tag'>main</div>
</div>
</td>
<td id="T_9ab09_row7_col2" class="data row7 col2" ><a href="https://github.com/NationalGalleryOfArt/opendata">link</a></td>
</tr>
<tr>
<th id="T_83701_level0_row4" class="row_heading level0 row4" >pascal</th>
<td id="T_83701_row4_col0" class="data row4 col0" >
<th id="T_9ab09_level0_row8" class="row_heading level0 row8" >pascal</th>
<td id="T_9ab09_row8_col0" class="data row8 col0" >
<div class='tags'>
<div class='tag'>image</div><div class='tag'>object recognition</div>
</div>
</td>
<td id="T_83701_row4_col1" class="data row4 col1" >
<td id="T_9ab09_row8_col1" class="data row8 col1" >
<div class='versions'>
<div class='tag'>2012</div>
</div>
</td>
<td id="T_83701_row4_col2" class="data row4 col2" ><a href="http://host.robots.ox.ac.uk/pascal/VOC/">link</a></td>
<td id="T_9ab09_row8_col2" class="data row8 col2" ><a href="http://host.robots.ox.ac.uk/pascal/VOC/">link</a></td>
</tr>
<tr>
<th id="T_9ab09_level0_row9" class="row_heading level0 row9" >fer</th>
<td id="T_9ab09_row9_col0" class="data row9 col0" >
<div class='tags'>
<div class='tag'>image</div><div class='tag'>facial recognition</div><div class='tag'>algorithmic bias</div>
</div>
</td>
<td id="T_9ab09_row9_col1" class="data row9 col1" >
<div class='versions'>
<div class='tag'>plus</div>
</div>
</td>
<td id="T_9ab09_row9_col2" class="data row9 col2" ><a href="http://www.whdeng.cn/RFW/testing.html">link</a></td>
</tr>
</tbody>
</table>
Expand Down

0 comments on commit 2be1209

Please sign in to comment.