-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Created a new documentation homepage.
Added image assets to be displayed on the homepage Restructured the API Reference section of the documentation Added library changes to the Release Notes sections
- Loading branch information
1 parent
b5d4632
commit cd4e2a0
Showing
8 changed files
with
104 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,75 @@ | ||
MLCompare Documentation | ||
======================= | ||
|
||
:mod:`MLCompare` is a Python package for running model comparison pipelines, with the aim of being both | ||
simple and flexible. It supports multiple popular ML libraries, retrieval from multiple online dataset | ||
repositories, common data processing steps, and results visualization. Additionally, it allows for using | ||
your own models and datasets within the pipelines. | ||
|
||
.. grid:: 1 2 2 2 | ||
:gutter: 4 | ||
:padding: 2 2 0 0 | ||
:class-container: sd-text-center | ||
|
||
.. grid-item-card:: User guide | ||
:img-top: assets/user-guide-icon.svg | ||
:class-card: intro-card | ||
:shadow: md | ||
|
||
The user guide provides information for getting started with MLCompare as well as important | ||
details for using the library. | ||
|
||
+++ | ||
|
||
.. button-ref:: user_guide | ||
:ref-type: ref | ||
:click-parent: | ||
:color: secondary | ||
:expand: | ||
|
||
see the User Guide | ||
|
||
.. grid-item-card:: API reference | ||
:img-top: assets/api-reference-icon.svg | ||
:class-card: intro-card | ||
:shadow: md | ||
|
||
The API Reference contains a detailed description of the MLCompare API and source code. | ||
It assumes familiarity with the library from the User Guide. | ||
|
||
+++ | ||
|
||
.. button-ref:: api_reference | ||
:ref-type: ref | ||
:click-parent: | ||
:color: secondary | ||
:expand: | ||
|
||
see the API Reference | ||
|
||
.. grid-item-card:: Release Notes | ||
:img-top: assets/release-notes-icon.svg | ||
:class-card: intro-card | ||
:shadow: md | ||
|
||
The release notes provide a summary of changes between each version of MLCompare. | ||
|
||
+++ | ||
|
||
.. button-ref:: release_notes | ||
:ref-type: ref | ||
:click-parent: | ||
:color: secondary | ||
:expand: | ||
|
||
see the Release Notes | ||
|
||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
:maxdepth: 3 | ||
:hidden: | ||
:titlesonly: | ||
|
||
user_guide/index | ||
api_reference/index | ||
release_notes/index | ||
|
||
|
||
Indices and tables | ||
================== | ||
|
||
* :ref:`genindex` | ||
* :ref:`modindex` | ||
* :ref:`search` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,28 @@ | ||
Release Notes | ||
============= | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
This is the list of changes to MLCompare between each release. For full details, | ||
see the `commit logs <https://github.com/MitchMedeiros/MLCompare/commits/>`_. | ||
|
||
Version 1.1.0 | ||
------------- | ||
|
||
- Refactored DatasetProcessor, moving save_directory from a class attribute to a method argument | ||
- Added type validation to several methods within DatasetProcessor | ||
- Updated docstrings for the dataset_processor module | ||
- Updated unit tests for DatasetProcessor | ||
- Added optimal device selection for PyTorch models as default behavior | ||
- Corrected a logging issue with model processing | ||
|
||
Version 1.0.1 | ||
------------- | ||
|
||
- Updated the project versioning to dynamically use the version in mlcompare/__init__.py | ||
- Modified the package attributes displayed on PyPi including adding links to documentation | ||
- Added the link to the documentation to the library __init__ | ||
- Created a GitHub action for publishing newly tagged versions to PyPi | ||
|
||
Version 1.0.0 | ||
------------- | ||
|
||
Initial Release |