From 636c06d86a22da7994fe0f290f23df368c3ccdae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gabriel=20Fern=C3=A1ndez=20Fern=C3=A1ndez?= Date: Tue, 18 Jul 2023 16:09:18 +0200 Subject: [PATCH] Eliminate quotation mark from repo description --- README.md | 23 ++++++++++++++++++++++- SPIVAE/__init__.py | 1 + SPIVAE/_modidx.py | 8 ++++++++ nbs/index.ipynb | 2 +- nbs/nbdev.yml | 2 +- settings.ini | 6 +++--- 6 files changed, 36 insertions(+), 6 deletions(-) create mode 100644 SPIVAE/__init__.py create mode 100644 SPIVAE/_modidx.py diff --git a/README.md b/README.md index 4b2b5c9..50fddd8 100644 --- a/README.md +++ b/README.md @@ -1 +1,22 @@ -This file will be overwritten by `index.ipynb` +# SPIVAE + + + +This file will become your README and also the index of your +documentation. + +## Install + +``` sh +pip install SPIVAE +``` + +## How to use + +Fill me in please! Don’t forget code examples: + +``` python +1+1 +``` + + 2 diff --git a/SPIVAE/__init__.py b/SPIVAE/__init__.py new file mode 100644 index 0000000..f102a9c --- /dev/null +++ b/SPIVAE/__init__.py @@ -0,0 +1 @@ +__version__ = "0.0.1" diff --git a/SPIVAE/_modidx.py b/SPIVAE/_modidx.py new file mode 100644 index 0000000..1701212 --- /dev/null +++ b/SPIVAE/_modidx.py @@ -0,0 +1,8 @@ +# Autogenerated by nbdev + +d = { 'settings': { 'branch': 'main', + 'doc_baseurl': '/SPIVAE', + 'doc_host': 'https://GabrielFernandezFernandez.github.io', + 'git_url': 'https://github.com/GabrielFernandezFernandez/SPIVAE', + 'lib_path': 'SPIVAE'}, + 'syms': {'SPIVAE.core': {'SPIVAE.core.foo': ('core.html#foo', 'SPIVAE/core.py')}}} diff --git a/nbs/index.ipynb b/nbs/index.ipynb index 8fff773..fe07169 100644 --- a/nbs/index.ipynb +++ b/nbs/index.ipynb @@ -16,7 +16,7 @@ "source": [ "# SPIVAE\n", "\n", - "> Stochastic processes insights from VAE. Code for the paper "Learning minimal representations of stochastic processes with variational autoencoders"." + "> Stochastic processes insights from VAE. Code for the paper: Learning minimal representations of stochastic processes with variational autoencoders." ] }, { diff --git a/nbs/nbdev.yml b/nbs/nbdev.yml index d83f157..4b325b9 100644 --- a/nbs/nbdev.yml +++ b/nbs/nbdev.yml @@ -4,6 +4,6 @@ project: website: title: "SPIVAE" site-url: "https://GabrielFernandezFernandez.github.io/SPIVAE" - description: "Stochastic processes insights from VAE. Code for the paper "Learning minimal representations of stochastic processes with variational autoencoders"." + description: "Stochastic processes insights from VAE. Code for the paper: Learning minimal representations of stochastic processes with variational autoencoders." repo-branch: main repo-url: "https://github.com/GabrielFernandezFernandez/SPIVAE" diff --git a/settings.ini b/settings.ini index 0eaef65..68e408b 100644 --- a/settings.ini +++ b/settings.ini @@ -31,13 +31,13 @@ audience = Developers author = Gabriel Fernández Fernández author_email = gabriel.fernandez@icfo.eu copyright = 2023 onwards, %(author)s -description = Stochastic processes insights from VAE. Code for the paper "Learning minimal representations of stochastic processes with variational autoencoders". -keywords = Unsupervised, Machine Learning, Variational Autoencoder, Feature Learning, Representation Learning, Autoregressive Model, Data Analysis, Knowledge Discovery, Interpretability, Anomalous Diffusion, Single Trajectory Characterization, Time Series, Stochastic Model, Brownian Motion, Fractional Brownian Motion, Scaled Brownian Motion, nbdev, jupyter, notebook, python +description = Stochastic processes insights from VAE. Code for the paper: Learning minimal representations of stochastic processes with variational autoencoders. +keywords = nbdev jupyter notebook python language = English status = 3 user = GabrielFernandezFernandez ### Optional ### -requirements = fastai andi-datasets>=2.0 +# requirements = fastcore pandas # dev_requirements = # console_scripts = \ No newline at end of file