From 1b366386c409269bfd4ebaffdee2bc40d81d2e13 Mon Sep 17 00:00:00 2001 From: SubhadityaMukherjee Date: Wed, 16 Oct 2024 17:54:48 +0200 Subject: [PATCH] cleaned up artefacts, updated documentation with a nav for global openml documentaion --- .gitignore | 169 +++++++++++++++++++++++++++++++++++++++- docs/Examples/.DS_Store | Bin 6148 -> 8196 bytes mkdocs.yml | 20 ++++- 3 files changed, 187 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index c7e7a70..8a1bfd1 100644 --- a/.gitignore +++ b/.gitignore @@ -13,4 +13,171 @@ build/ dist/ openml_pytorch.egg-info/ -datasets/ \ No newline at end of file +datasets/ + +dist/ + +build/* + +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/latest/usage/project/#working-with-version-control +.pdm.toml +.pdm-python +.pdm-build/ + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ \ No newline at end of file diff --git a/docs/Examples/.DS_Store b/docs/Examples/.DS_Store index feb937f6d4a43340b74e0f3fd7b3b1d3f550004c..fc16b09d8426a731342b40c67487c4e9658598ed 100644 GIT binary patch literal 8196 zcmeHMU2GIp6u#fIz|54=TWD$N2w7$MOb1$nv*;x)QP4-Iw7evXOQL$;gb+R=y4rCYdcmkFtAOFR1OW=j_HnfyCui; z0^76{sG6o_xN-XQnq=qt4e?kqx$aCnb~@RSNW^2E8{5yE(bUG)hd1rd950MI?pf&# z!Z!k|o#x%S*<34llN2Dy~Y?EI;dy(!ZNLY&zNt!j(5N+dPFn4&Lcl} ze4<~J@~zM?JB-t~Czj@|nvYZugUU0>8NShhVoSFjFdy}ad^ zwsUk~+&2AV!xTivw~yFXQPb+H=k+_;QEQSfZfaiAVi;2AwoPT0p;FF1QL_D0yj4{v z`GUIIWkyUtWYU^;yQY}URQV@bAZayX#)y#g6fNq_&|szUklyc+TPn{=#kjs!?>|nv ztZ`3{B=z;iKp~s63K}=%b2{`+W3Vh^tMOfOaFhP1F_d>lN68gWt4CZ8r;KjnDe>ed zvYx+Z%yPu4u1Hy*vCSCvj%AD1o^b-2%CE}toirZo8A*g$pK1GUQLLFl@?^{~4vGo4 zm}cNe^Wr9Mq>TZUf34E?*iP9dc+<8^l&h_&)pCb|u(qZWlG7-8maw&SNNs0_=*O=y zc8a~i-eTw3hwM{!iCtx1u^a4L_8t44{m6b{zp=kijat-!qaH0-iB(vQHf%r&ThNVN z*o%EgqaTNnLmn26z(omVoWvK3LX2rIa|6U_mHrvN{IaIoLgus0bbmHxoe zN*3MDE172lgnjFzDgeyqh1w4;R|)%kPROoUN$f5@SF$Z_ah39nD*>ywB$66s6R!%{ zwsvA68U2wijq-|DPcCU{Uc6a__Y~c9|eMNs#@C{mg!4 zH=zG}#{dps2*U(flR$eEHj41z6L6o!1fIhS zc#&ZHDqh3ucmwD0HUap(5WpYfi)nz|ITet&IF*mMei@pG|Nb8+MO_qu zC<6b_2%x$*-P=vRRlWzNyD4hz7+p`(C7RHikTfu%PN<0Spd2T9>kmV^kA<>SNGBvE a3AO+HhXC;r8lC^MeX>U9e}KsQqx&11Z6Txp delta 133 zcmZp1XfcprU|?W$DortDU=RQ@Ie-{MGjdEU6q~50$jCS`U^gStr<9FQF# MYZ*4j^UPre0I4Sv4FCWD diff --git a/mkdocs.yml b/mkdocs.yml index 483a917..6525e58 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -36,6 +36,7 @@ markdown_extensions: plugins: - search - mkdocs-jupyter + - awesome-pages # - mknotebooks: # execute: false - mkdocstrings: @@ -47,4 +48,21 @@ plugins: show_source: true options: docstring_section_style: table - show_docstring_functions: true \ No newline at end of file + show_docstring_functions: true + +nav: + - Home: "index.md" + - "API Reference": + - "Callbacks": "API reference/Callbacks.md" + - "Custom Datasets": "API reference/Custom Datasets.md" + - "Metrics" : "API reference/Metrics.md" + - "OpenML Connection" : "API reference/OpenML Connection.md" + - "Trainer" : "API reference/Trainer.md" + - Examples: + - "Create Dataset and Task" : "Examples/Create Dataset and Task.ipynb" + - "Image Classification Task" : "Examples/Image Classification Task.ipynb" + - "Pretrained Transformer Image Classification Task" : "Examples/Pretrained Transformer Image Classification Task.ipynb" + - "Sequential Classification Task" : "Examples/Sequential Classification Task.ipynb" + - "Tabular Classification" : "Examples/Tabular Classification.ipynb" + - "Limitations of the API": "Limitations of the API.md" + - "Philosphy behind the API Design" : "Philosophy behind the API Design.md" \ No newline at end of file