Skip to content

Commit

Permalink
deploy: 91e471e
Browse files Browse the repository at this point in the history
  • Loading branch information
@isabelizimm
isabelizimm committed Aug 6, 2024
1 parent cd31e7a commit 4d3ab2a
Show file tree
Hide file tree
Showing 27 changed files with 433 additions and 433 deletions.
24 changes: 12 additions & 12 deletions customize-pins-metadata.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>

<meta charset="utf-8">
<meta name="generator" content="quarto-1.5.55">
<meta name="generator" content="quarto-1.5.56">

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

Expand Down Expand Up @@ -190,7 +190,7 @@ <h1 class="title">Create consistent metadata for pins</h1>

<p>The <code>metadata</code> argument in pins is flexible and can hold any kind of metadata that you can formulate as a <code>dict</code> (convertable to JSON). In some situations, you may want to read and write with <em>consistent</em> customized metadata; you can create functions to wrap <a href="./reference/pin_write.html#pins.boards.BaseBoard.pin_write"><code>pin_write</code></a> and <a href="./reference/pin_read.html#pins.boards.BaseBoard.pin_read"><code>pin_read</code></a> for your particular use case.</p>
<p>We’ll begin by creating a temporary board for demonstration:</p>
<div id="7f112560" class="cell" data-execution_count="1">
<div id="dc65dbbb" class="cell" data-execution_count="1">
<div class="sourceCode cell-code" id="cb1"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> pins</span>
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> pandas <span class="im">as</span> pd</span>
<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a></span>
Expand All @@ -202,7 +202,7 @@ <h1 class="title">Create consistent metadata for pins</h1>
<h1>A function to store pandas Categoricals</h1>
<p>Say you want to store a pandas Categorical object as JSON together with the <em>categories</em> of the categorical in the metadata.</p>
<p>For example, here is a simple categorical and its categories:</p>
<div id="c75ae517" class="cell" data-execution_count="2">
<div id="877b7b48" class="cell" data-execution_count="2">
<div class="sourceCode cell-code" id="cb2"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a>some_cat <span class="op">=</span> pd.Categorical([<span class="st">"a"</span>, <span class="st">"a"</span>, <span class="st">"b"</span>])</span>
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a>some_cat.categories</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
Expand All @@ -212,7 +212,7 @@ <h1>A function to store pandas Categoricals</h1>
</div>
<p>Notice that the categories attribute is just the unique values in the categorical.</p>
<p>We can write a function wrapping <a href="./reference/pin_write.html#pins.boards.BaseBoard.pin_write"><code>pin_write</code></a> that holds the categories in metadata, so we can easily re-create the categorical with them.</p>
<div id="65f3f454" class="cell" data-execution_count="3">
<div id="402fac93" class="cell" data-execution_count="3">
<div class="sourceCode cell-code" id="cb4"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="kw">def</span> pin_write_cat_json(</span>
<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a> board,</span>
<span id="cb4-3"><a href="#cb4-3" aria-hidden="true" tabindex="-1"></a> x: pd.Categorical,</span>
Expand All @@ -224,41 +224,41 @@ <h1>A function to store pandas Categoricals</h1>
<span id="cb4-9"><a href="#cb4-9" aria-hidden="true" tabindex="-1"></a> board.pin_write(json_data, name <span class="op">=</span> name, <span class="bu">type</span> <span class="op">=</span> <span class="st">"json"</span>, metadata <span class="op">=</span> metadata, <span class="op">**</span>kwargs)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</div>
<p>We can use this new function to write a pin as JSON with our specific metadata:</p>
<div id="f120ce10" class="cell" data-execution_count="4">
<div id="483dee81" class="cell" data-execution_count="4">
<div class="sourceCode cell-code" id="cb5"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a>some_cat <span class="op">=</span> pd.Categorical([<span class="st">"a"</span>, <span class="st">"a"</span>, <span class="st">"b"</span>, <span class="st">"c"</span>])</span>
<span id="cb5-2"><a href="#cb5-2" aria-hidden="true" tabindex="-1"></a>pin_write_cat_json(board, some_cat, name <span class="op">=</span> <span class="st">"some-cat"</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-stderr">
<pre><code>/tmp/ipykernel_2250/2180373110.py:8: FutureWarning: Categorical.to_list is deprecated and will be removed in a future version. Use obj.tolist() instead
<pre><code>/tmp/ipykernel_2122/2180373110.py:8: FutureWarning: Categorical.to_list is deprecated and will be removed in a future version. Use obj.tolist() instead
json_data = x.to_list()
Writing pin:
Name: 'some-cat'
Version: 20240801T032646Z-6ce8e</code></pre>
Version: 20240806T220623Z-6ce8e</code></pre>
</div>
</div>
<section id="a-function-to-read-categoricals" class="level2">
<h2 class="anchored" data-anchor-id="a-function-to-read-categoricals">A function to read categoricals</h2>
<p>It’s possible to read this pin using the regular <a href="./reference/pin_read.html#pins.boards.BaseBoard.pin_read"><code>pin_read</code></a> function, but the object we get is no longer a categorical!</p>
<div id="0e6acc84" class="cell" data-execution_count="5">
<div id="e5bd8129" class="cell" data-execution_count="5">
<div class="sourceCode cell-code" id="cb7"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a>board.pin_read(<span class="st">"some-cat"</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-display" data-execution_count="5">
<pre><code>['a', 'a', 'b', 'c']</code></pre>
</div>
</div>
<p>However, notice that if we use <a href="./reference/pin_meta.html#pins.boards.BaseBoard.pin_meta"><code>pin_meta</code></a>, the information we stored on categories is in the <code>.user</code> field.</p>
<div id="c7c0ad13" class="cell" data-execution_count="6">
<div id="cb1a92f7" class="cell" data-execution_count="6">
<div class="sourceCode cell-code" id="cb9"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb9-1"><a href="#cb9-1" aria-hidden="true" tabindex="-1"></a>pprint(</span>
<span id="cb9-2"><a href="#cb9-2" aria-hidden="true" tabindex="-1"></a> board.pin_meta(<span class="st">"some-cat"</span>)</span>
<span id="cb9-3"><a href="#cb9-3" aria-hidden="true" tabindex="-1"></a>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-stdout">
<pre><code>Meta(title='some-cat: a pinned list object',
description=None,
created='20240801T032646Z',
created='20240806T220623Z',
pin_hash='6ce8eaa9de0dfd54',
file='some-cat.json',
file_size=20,
type='json',
api_version=1,
version=Version(created=datetime.datetime(2024, 8, 1, 3, 26, 46),
version=Version(created=datetime.datetime(2024, 8, 6, 22, 6, 23),
hash='6ce8e'),
tags=None,
name='some-cat',
Expand All @@ -267,7 +267,7 @@ <h2 class="anchored" data-anchor-id="a-function-to-read-categoricals">A function
</div>
</div>
<p>This enables us to write a special function for reading, to reconstruct the categorical, using the categories stashed in metadata:</p>
<div id="77ae77a4" class="cell" data-execution_count="7">
<div id="92aa2069" class="cell" data-execution_count="7">
<div class="sourceCode cell-code" id="cb11"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb11-1"><a href="#cb11-1" aria-hidden="true" tabindex="-1"></a><span class="kw">def</span> pin_read_cat_json(board, name, version<span class="op">=</span><span class="va">None</span>, <span class="bu">hash</span><span class="op">=</span><span class="va">None</span>, <span class="op">**</span>kwargs):</span>
<span id="cb11-2"><a href="#cb11-2" aria-hidden="true" tabindex="-1"></a> data <span class="op">=</span> board.pin_read(name <span class="op">=</span> name, version <span class="op">=</span> version, <span class="bu">hash</span> <span class="op">=</span> <span class="bu">hash</span>, <span class="op">**</span>kwargs)</span>
<span id="cb11-3"><a href="#cb11-3" aria-hidden="true" tabindex="-1"></a> meta <span class="op">=</span> board.pin_meta(name <span class="op">=</span> name, version <span class="op">=</span> version, <span class="op">**</span>kwargs)</span>
Expand Down
Loading

0 comments on commit 4d3ab2a

Please sign in to comment.