Update lib and docs

README.md

@@ -12,7 +12,7 @@ This file will become your README and also the index of your documentation.
 
 Fill me in please! Don't forget code examples:
 
-```python
+```
 1 + 1
 ```
 
@@ -22,3 +22,7 @@ Fill me in please! Don't forget code examples:
     2
 
 
+
+# Contributing
+
+See https://github.com/WM-SEMERU/mlproj_template/blob/main/CONTRIBUTING.md for how to contribute.

docs/_data/sidebars/home_sidebar.yml

@@ -10,8 +10,11 @@ entries:
       title: Overview
       url: /
     - output: web,pdf
-      title: module name here
+      title: Core
       url: core.html
+    - output: web,pdf
+      title: CLI
+      url: cli.html
     output: web
     title: mlproj_template
   output: web

docs/cli.html

@@ -0,0 +1,169 @@
+---
+
+title: CLI
+
+
+keywords: fastai
+sidebar: home_sidebar
+
+summary: "Contains all the CLI functions that your library provides."
+description: "Contains all the CLI functions that your library provides."
+nb_path: "nbs/01_cli.ipynb"
+---
+<!--
+
+#################################################
+### THIS FILE WAS AUTOGENERATED! DO NOT EDIT! ###
+#################################################
+# file to edit: nbs/01_cli.ipynb
+# command to build the docs after a change: nbdev_build_docs
+
+-->
+
+<div class="container" id="notebook-container">
+
+    {% raw %}
+
+<div class="cell border-box-sizing code_cell rendered">
+
+</div>
+    {% endraw %}
+
+    {% raw %}
+
+<div class="cell border-box-sizing code_cell rendered">
+
+</div>
+    {% endraw %}
+
+    {% raw %}
+
+<div class="cell border-box-sizing code_cell rendered">
+
+<div class="output_wrapper">
+<div class="output">
+
+<div class="output_area">
+
+
+<div class="output_markdown rendered_html output_subarea ">
+<h4 id="process_data" class="doc_header"><code>process_data</code><a href="https://github.com/wm-semeru/mlproj_template/tree/main/mlproj_template/cli.py#L9" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>process_data</code>(<strong><code>param1</code></strong>:"The message")</p>
+</blockquote>
+<p>Function for processing data related to the library.</p>
+
+</div>
+
+</div>
+
+</div>
+</div>
+
+</div>
+    {% endraw %}
+
+    {% raw %}
+
+<div class="cell border-box-sizing code_cell rendered">
+
+</div>
+    {% endraw %}
+
+    {% raw %}
+
+<div class="cell border-box-sizing code_cell rendered">
+
+<div class="output_wrapper">
+<div class="output">
+
+<div class="output_area">
+
+
+<div class="output_markdown rendered_html output_subarea ">
+<h4 id="train" class="doc_header"><code>train</code><a href="https://github.com/wm-semeru/mlproj_template/tree/main/mlproj_template/cli.py#L15" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>train</code>(<strong><code>param1</code></strong>:"The message")</p>
+</blockquote>
+<p>Function for training models related to the library.</p>
+
+</div>
+
+</div>
+
+</div>
+</div>
+
+</div>
+    {% endraw %}
+
+    {% raw %}
+
+<div class="cell border-box-sizing code_cell rendered">
+
+</div>
+    {% endraw %}
+
+    {% raw %}
+
+<div class="cell border-box-sizing code_cell rendered">
+
+<div class="output_wrapper">
+<div class="output">
+
+<div class="output_area">
+
+
+<div class="output_markdown rendered_html output_subarea ">
+<h4 id="evaluate" class="doc_header"><code>evaluate</code><a href="https://github.com/wm-semeru/mlproj_template/tree/main/mlproj_template/cli.py#L21" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>evaluate</code>(<strong><code>param1</code></strong>:"The message")</p>
+</blockquote>
+<p>Function for evaluating models related to the library.</p>
+
+</div>
+
+</div>
+
+</div>
+</div>
+
+</div>
+    {% endraw %}
+
+    {% raw %}
+
+<div class="cell border-box-sizing code_cell rendered">
+
+</div>
+    {% endraw %}
+
+    {% raw %}
+
+<div class="cell border-box-sizing code_cell rendered">
+
+<div class="output_wrapper">
+<div class="output">
+
+<div class="output_area">
+
+
+<div class="output_markdown rendered_html output_subarea ">
+<h4 id="reproduce" class="doc_header"><code>reproduce</code><a href="https://github.com/wm-semeru/mlproj_template/tree/main/mlproj_template/cli.py#L27" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>reproduce</code>(<strong><code>param1</code></strong>:"The message")</p>
+</blockquote>
+<p>Function for reproducing results related to the library.</p>
+
+</div>
+
+</div>
+
+</div>
+</div>
+
+</div>
+    {% endraw %}
+
+    {% raw %}
+
+<div class="cell border-box-sizing code_cell rendered">
+
+</div>
+    {% endraw %}
+
+</div>
+
+

docs/core.html

@@ -1,6 +1,6 @@
 ---
 
-title: module name here
+title: Core
 
 
 keywords: fastai

docs/index.html

@@ -95,6 +95,13 @@ <h2 id="How-to-use">How to use<a class="anchor-link" href="#How-to-use"> </a></h
 </div>
     {% endraw %}
 
+<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
+<div class="text_cell_render border-box-sizing rendered_html">
+<h1 id="Contributing">Contributing<a class="anchor-link" href="#Contributing"> </a></h1><p>See <a href="https://github.com/WM-SEMERU/mlproj_template/blob/main/CONTRIBUTING.md">https://github.com/WM-SEMERU/mlproj_template/blob/main/CONTRIBUTING.md</a> for how to contribute.</p>
+
+</div>
+</div>
+</div>
 </div>
 
 

docs/sidebar.json

@@ -1,6 +1,7 @@
 {
   "mlproj_template": {
     "Overview": "/",
-    "module name here": "core.html"
+    "Core": "core.html",
+    "CLI": "cli.html"
   }
 }

mlproj_template/_nbdev.py

@@ -2,9 +2,14 @@
 
 __all__ = ["index", "modules", "custom_doc_links", "git_url"]
 
-index = {"example_func": "00_core.ipynb"}
+index = {"example_func": "00_core.ipynb",
+         "process_data": "01_cli.ipynb",
+         "train": "01_cli.ipynb",
+         "evaluate": "01_cli.ipynb",
+         "reproduce": "01_cli.ipynb"}
 
-modules = ["core.py"]
+modules = ["core.py",
+           "cli.py"]
 
 doc_url = "https://wm-semeru.github.io/mlproj_template/"
 

mlproj_template/cli.py

@@ -0,0 +1,30 @@
+# AUTOGENERATED! DO NOT EDIT! File to edit: nbs/01_cli.ipynb (unless otherwise specified).
+
+__all__ = ['process_data', 'train', 'evaluate', 'reproduce']
+
+# Cell
+from fastcore.script import call_parse, Param
+
+# Cell
+@call_parse
+def process_data(param1: Param("The message", str)):
+    """Function for processing data related to the library."""
+    pass
+
+# Cell
+@call_parse
+def train(param1: Param("The message", str)):
+    """Function for training models related to the library."""
+    pass
+
+# Cell
+@call_parse
+def evaluate(param1: Param("The message", str)):
+    """Function for evaluating models related to the library."""
+    pass
+
+# Cell
+@call_parse
+def reproduce(param1: Param("The message", str)):
+    """Function for reproducing results related to the library."""
+    pass