Skip to content

Commit

Permalink
Deployed e9f2f63 to stable with MkDocs 1.5.3 and mike 2.1.3
Browse files Browse the repository at this point in the history
  • Loading branch information
maclandrol committed Sep 10, 2024
1 parent 8aed855 commit feaae2d
Show file tree
Hide file tree
Showing 12 changed files with 2,475 additions and 512 deletions.
1,282 changes: 862 additions & 420 deletions stable/api/safe.html

Large diffs are not rendered by default.

28 changes: 14 additions & 14 deletions stable/api/safe.models.html
Original file line number Diff line number Diff line change
Expand Up @@ -1144,7 +1144,7 @@ <h2 id="safe.trainer.model.PropertyHead" class="doc doc-heading">
Bases: <code><span title="torch.nn.Module">Module</span></code></p>


<p>Compute a single vector summary of a sequence hidden states.</p>
<p>Compute a single vector summary of a sequence hidden states.</p>


<p><span class="doc-section-title">Parameters:</span></p>
Expand Down Expand Up @@ -1390,7 +1390,7 @@ <h3 id="safe.trainer.model.PropertyHead.forward" class="doc doc-heading">

<div class="doc doc-contents ">

<p>Compute a single vector summary of a sequence hidden states.</p>
<p>Compute a single vector summary of a sequence hidden states.</p>


<p><span class="doc-section-title">Parameters:</span></p>
Expand Down Expand Up @@ -1586,7 +1586,7 @@ <h2 id="safe.trainer.model.SAFEDoubleHeadsModel" class="doc doc-heading">
Bases: <code><span title="transformers.GPT2DoubleHeadsModel">GPT2DoubleHeadsModel</span></code></p>


<p>The safe model is a dual head GPT2 model with a language modeling head and an optional multi-task regression head</p>
<p>The safe model is a dual head GPT2 model with a language modeling head and an optional multi-task regression head</p>

<details class="quote">
<summary>Source code in <code>safe/trainer/model.py</code></summary>
Expand Down Expand Up @@ -1911,7 +1911,7 @@ <h3 id="safe.trainer.model.SAFEDoubleHeadsModel.forward" class="doc doc-heading"
</tr>
</tbody>
</table>
<p>Returns:
<p>Returns:
output (GPT2DoubleHeadsModelOutput): output of the model</p>

<details class="quote">
Expand Down Expand Up @@ -2176,7 +2176,7 @@ <h2 id="safe.trainer.trainer_utils.SAFETrainer" class="doc doc-heading">
Bases: <code><span title="transformers.Trainer">Trainer</span></code></p>


<p>Custom trainer for training SAFE model.</p>
<p>Custom trainer for training SAFE model.</p>
<p>This custom trainer changes the loss function to support the property head</p>

<details class="quote">
Expand Down Expand Up @@ -2302,7 +2302,7 @@ <h3 id="safe.trainer.trainer_utils.SAFETrainer.compute_loss" class="doc doc-head

<div class="doc doc-contents ">

<p>How the loss is computed by Trainer. By default, all models return the loss in the first element.</p>
<p>How the loss is computed by Trainer. By default, all models return the loss in the first element.</p>

<details class="quote">
<summary>Source code in <code>safe/trainer/trainer_utils.py</code></summary>
Expand Down Expand Up @@ -2434,7 +2434,7 @@ <h2 id="safe.trainer.collator.SAFECollator" class="doc doc-heading">
<div class="doc doc-contents ">


<p>Collate function for language modelling tasks</p>
<p>Collate function for language modelling tasks</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The collate function is based on the default DataCollatorForLanguageModeling in huggingface
Expand Down Expand Up @@ -2664,7 +2664,7 @@ <h3 id="safe.trainer.collator.SAFECollator.__call__" class="doc doc-heading">

<div class="doc doc-contents ">

<p>Call collate function</p>
<p>Call collate function</p>


<p><span class="doc-section-title">Parameters:</span></p>
Expand Down Expand Up @@ -2817,7 +2817,7 @@ <h3 id="safe.trainer.collator.SAFECollator.__init__" class="doc doc-heading">

<div class="doc doc-contents ">

<p>Default collator for huggingface transformers in izanagi.</p>
<p>Default collator for huggingface transformers in izanagi.</p>


<p><span class="doc-section-title">Parameters:</span></p>
Expand Down Expand Up @@ -2998,7 +2998,7 @@ <h3 id="safe.trainer.collator.SAFECollator.get_tokenizer" class="doc doc-heading

<div class="doc doc-contents ">

<p>Get underlying tokenizer</p>
<p>Get underlying tokenizer</p>

<details class="quote">
<summary>Source code in <code>safe/trainer/collator.py</code></summary>
Expand Down Expand Up @@ -3068,7 +3068,7 @@ <h2 id="safe.trainer.data_utils.get_dataset" class="doc doc-heading">

<div class="doc doc-contents ">

<p>Get the datasets from the config file</p>
<p>Get the datasets from the config file</p>

<details class="quote">
<summary>Source code in <code>safe/trainer/data_utils.py</code></summary>
Expand Down Expand Up @@ -3244,7 +3244,7 @@ <h2 id="safe.trainer.data_utils.get_dataset_column_names" class="doc doc-heading

<div class="doc doc-contents ">

<p>Get the column names in a dataset</p>
<p>Get the column names in a dataset</p>


<p><span class="doc-section-title">Parameters:</span></p>
Expand Down Expand Up @@ -3321,7 +3321,7 @@ <h2 id="safe.trainer.data_utils.take" class="doc doc-heading">

<div class="doc doc-contents ">

<p>Return first n items of the iterable as a list</p>
<p>Return first n items of the iterable as a list</p>

<details class="quote">
<summary>Source code in <code>safe/trainer/data_utils.py</code></summary>
Expand All @@ -3347,7 +3347,7 @@ <h2 id="safe.trainer.data_utils.tokenize_fn" class="doc doc-heading">

<div class="doc doc-contents ">

<p>Perform the tokenization of a row
<p>Perform the tokenization of a row
Args:
row: row to tokenize
tokenizer: tokenizer to use
Expand Down
2 changes: 1 addition & 1 deletion stable/api/safe.viz.html
Original file line number Diff line number Diff line change
Expand Up @@ -679,7 +679,7 @@ <h2 id="safe.viz.to_image" class="doc doc-heading">

<div class="doc doc-contents ">

<p>Display a safe string by highlighting the fragments that make it.</p>
<p>Display a safe string by highlighting the fragments that make it.</p>


<p><span class="doc-section-title">Parameters:</span></p>
Expand Down
Binary file modified stable/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion stable/search/search_index.json

Large diffs are not rendered by default.

27 changes: 16 additions & 11 deletions stable/sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,57 +2,62 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://github.com/datamol-io/safe/stable/index.html</loc>
<lastmod>2024-07-30</lastmod>
<lastmod>2024-09-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://github.com/datamol-io/safe/stable/cli.html</loc>
<lastmod>2024-07-30</lastmod>
<lastmod>2024-09-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://github.com/datamol-io/safe/stable/data_license.html</loc>
<lastmod>2024-07-30</lastmod>
<lastmod>2024-09-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://github.com/datamol-io/safe/stable/license.html</loc>
<lastmod>2024-07-30</lastmod>
<lastmod>2024-09-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://github.com/datamol-io/safe/stable/api/safe.html</loc>
<lastmod>2024-07-30</lastmod>
<lastmod>2024-09-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://github.com/datamol-io/safe/stable/api/safe.models.html</loc>
<lastmod>2024-07-30</lastmod>
<lastmod>2024-09-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://github.com/datamol-io/safe/stable/api/safe.viz.html</loc>
<lastmod>2024-07-30</lastmod>
<lastmod>2024-09-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://github.com/datamol-io/safe/stable/tutorials/design-with-safe.html</loc>
<lastmod>2024-07-30</lastmod>
<lastmod>2024-09-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://github.com/datamol-io/safe/stable/tutorials/extracting-representation-molfeat.html</loc>
<lastmod>2024-07-30</lastmod>
<lastmod>2024-09-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://github.com/datamol-io/safe/stable/tutorials/getting-started.html</loc>
<lastmod>2024-07-30</lastmod>
<lastmod>2024-09-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://github.com/datamol-io/safe/stable/tutorials/how-it-works.html</loc>
<lastmod>2024-07-30</lastmod>
<lastmod>2024-09-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://github.com/datamol-io/safe/stable/tutorials/load-from-wandb.html</loc>
<lastmod>2024-09-10</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
Binary file modified stable/sitemap.xml.gz
Binary file not shown.
42 changes: 21 additions & 21 deletions stable/tutorials/design-with-safe.html

Large diffs are not rendered by default.

30 changes: 15 additions & 15 deletions stable/tutorials/extracting-representation-molfeat.html

Large diffs are not rendered by default.

36 changes: 18 additions & 18 deletions stable/tutorials/getting-started.html

Large diffs are not rendered by default.

22 changes: 11 additions & 11 deletions stable/tutorials/how-it-works.html

Large diffs are not rendered by default.

Loading

0 comments on commit feaae2d

Please sign in to comment.