https://github.com/veit/dvc-example

https://github.com/veit/dvc-example

data-science dvc git machine-learning

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/veit/dvc-example
• Owner: veit
• License: bsd-3-clause
• Created: 2020-06-07T20:46:15.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-07-17T13:18:14.000Z (6 months ago)
• Last Synced: 2024-07-18T10:04:13.272Z (6 months ago)
• Topics: data-science, dvc, git, machine-learning
• Language: Python
• Homepage: https://dvc-example.readthedocs.io/
• Size: 23.4 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Quick start

===========

|Contributors| |License| |Docs|

.. |Contributors| image:: https://img.shields.io/github/contributors/veit/dvc-example.svg

   :target: https://github.com/veit/dvc-example/graphs/contributors

.. |License| image:: https://img.shields.io/github/license/veit/dvc-example.svg

   :target: https://github.com/veit/dvc-example/blob/master/LICENSE

.. |Docs| image:: https://readthedocs.org/projects/dvc-example/badge/?version=latest

   :target: https://dvc-example.readthedocs.io/de/latest/

Installation

------------

#. Download and unpack:

   .. code-block:: console

    $ curl -O https://codeload.github.com/veit/dvc-example/zip/master

    $ unzip master

    Archive:  master

    …

       creating: dvc-example-master/

    …

#. Create HTML documentation:

   .. code-block:: console

    $ python3 -m venv .

    $ bin/python -m pip install --upgrade pip

    $ bin/python -m pip install -r requirements.txt

    $ bin/sphinx-build -ab html docs/ docs/_build/

#. Create PDF:

   To create PDFs you need additional packages.

   For Debian/Ubuntu you can get them with:

   .. code-block:: console

    $ apt-get install texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended latexmk

   or for Mac OS X with:

   .. code-block:: console

    $ brew cask install mactex

    …

    🍺  mactex was successfully installed!

    $ curl --remote-name https://www.tug.org/fonts/getnonfreefonts/install-getnonfreefonts

    $ sudo texlua install-getnonfreefonts

    …

    mktexlsr: Updating /usr/local/texlive/2020/texmf-dist/ls-R...

    mktexlsr: Done.

   You can then generate a PDF with:

   .. code-block:: console

    $ cd docs/

    $ pipenv run make latexpdf

    …

    The LaTeX files are in _build/latex.

    Run 'make' in that directory to run these through (pdf)latex

    …

   You will then find the PDF in :file:`docs/_build/latex/dvc-example.pdf`.

Follow us

---------

* `GitHub `_

* `Twitter `_

* `Mastodon `_

Pull requests

-------------

If you have suggestions for improvements and additions, I recommend you, create a `Fork

`_ of my GitHub repository

`_ and make your changes in it. You are also

welcome to make a *Pull request* if you like. As long as the changes in it are small and

atomic, I’m happy to look at your your suggestions with pleasure.