Skip to content

Commit

Permalink
Created a new documentation homepage.
Browse files Browse the repository at this point in the history
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
MitchMedeiros committed Sep 6, 2024
1 parent b5d4632 commit cd4e2a0
Show file tree
Hide file tree
Showing 8 changed files with 104 additions and 24 deletions.
11 changes: 2 additions & 9 deletions docs/source/api_reference/data_processing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ Data Processing

.. currentmodule:: mlcompare.data

The DatasetProcessor class takes in a Dataset instance and performs data preparation on the constructed Pandas DataFrame.
It heavily utilizes Scikit-learn for its data processing capabilities.

Classes
-------
Expand All @@ -11,18 +13,9 @@ Classes
:toctree: generated/
:template: custom_class.rst

data_processor.DataProcessor
dataset_processor.DatasetProcessor
split_data.SplitData

DataProcessor
============

.. autoclass:: mlcompare.DataProcessor
:members:
:undoc-members:
:show-inheritance:

DatasetProcessor
=============

Expand Down
3 changes: 3 additions & 0 deletions docs/source/api_reference/datasets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ Datasets

.. currentmodule:: mlcompare.data

The various Dataset classes primarily serve to turn a source of data into a Pandas DataFrame. Additionally, they
pass any user provided parameters to the DatasetProcessor.

Classes
-------

Expand Down
8 changes: 4 additions & 4 deletions docs/source/api_reference/pipelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,17 @@ Functions
data_exploration_pipeline

Full Pipeline
===========
=============

.. autoclass:: mlcompare.full_pipeline
:members:
:undoc-members:
:show-inheritance:

Data Exploration Pipeline
=========================
Data Pipeline
=============

.. autoclass:: mlcompare.data_exploration_pipeline
.. autoclass:: mlcompare.data_pipeline
:members:
:undoc-members:
:show-inheritance:
Expand Down
1 change: 1 addition & 0 deletions docs/source/assets/api-reference-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/source/assets/release-notes-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/source/assets/user-guide-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
76 changes: 67 additions & 9 deletions docs/source/index.rst
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`
27 changes: 25 additions & 2 deletions docs/source/release_notes/index.rst
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

0 comments on commit cd4e2a0

Please sign in to comment.