Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Initial TT-ICE integration #34

Open
wants to merge 34 commits into
base: dev
Choose a base branch
from
Open

Initial TT-ICE integration #34

wants to merge 34 commits into from

Conversation

dorukaks
Copy link
Contributor

@dorukaks dorukaks commented Nov 29, 2022

Purpose

PR from feat/doruk/8_11_13 to dev that incorporates the initial "release" of TT-ICE package. CuPy support will be provided after this initial release.

Closes #8
Closes #11
Closes #13

I'm planning to create separate branches from feat/doruk/8_11_13 for each individual issue and merge into feat/doruk/8_11_13.

  • Import initial release of TT-ICE package
  • Implement good software practices to TT-ICE package
  • Create docstrings for automated documentation creation

Type of change

  • New feature (non-breaking change which adds functionality)
  • Code style update (formatting, renaming)
  • Documentation update

Checklist

Put an x in the boxes that apply.

  • My code functions as intended
  • I have used camelCase in my variable and function names
  • I have commented my code properly
  • I have provided the necessary prompts for automatic documentation
  • I have provided a toy case under the examples folder
  • I have addressed all the issues entirely

Placeholder commit to identify the parent branch correctly
@dorukaks dorukaks added documentation Improvements or additions to documentation enhancement New feature or request TT-ICE Everything related to TT-ICE labels Nov 29, 2022
@dorukaks dorukaks added this to the TT-ICE integration milestone Nov 29, 2022
@dorukaks dorukaks self-assigned this Nov 29, 2022
@dorukaks
Copy link
Contributor Author

sorry about the format of the initial commit message, forgot the exact format for a second

dorukaks and others added 22 commits December 13, 2022 09:48
To avoid any bugs caused by old version
* (test) create initial .yml file to test function

There will be A LOT of commits while testing this feature be ready...

* (test) create sphinx .yml file to test function

* (fix) add installation of sphinx-rtd-theme

* (fix) change sphinx-action repository version

* (fix) change repo versions for actions

* (test) create environment for auto docs

* (fix) change theme installation sequence

* (test) change rtd_theme import style

* (fix) change requirement declaration

* (fix) correct id in deploy step

* (test) try publishing documentation

* (test) tweak action workflow to publish pages

* (test) moved autoDocs to avoid build confusion

* (fix) change artifact path

* (fix) change artifact path

* (test) create an empty file to create html folder

* (test) change workflow options to make this work

* (fix) change build command according to sphinx issues

* (fix) indicate config file location in workflow

* (fix) indicate config file location in workflow

* (fix) change build command

* (fix) change build command

* (fix) change build command

* (fix) change artifact build path

* (fix) correct the hyperlink on introduction.rst

* (fix) change insrted path from gim to src

* (fix) create requirements.txt for whole pipeline

* (docs) create links for packages

* (test) write a test function into TTICE for docs

* (test) create TTICE.rst to test autodocs

* (test) change directory path in index.rst

* (test) change directory path in index.rst

* (test): Change sphinx (GH action) build command

Changed the sphinx build command to `make html`

* (test): Add sphinx api build to GH actions

Added sphinx api build command for building

* (test): Change build-command to run for Sphinx

Changed the build command to run for sphinx gh action

* (refactor) Delete redundant files

Delete the following files:
requirements.txt
environment.yml

* (reformat): Remane the sphinx workflow

sphinx workflow was renamed to createDocumentation

* (feat): Add sphinx build check workflow

Added sphinx build check workflow

* (refactor) remove redundant module calls in index

Removed redundant module calls in index.rst

* (wip) Check pre-build command for sphinx-action

* (fix) Fix typo for pre-build-command

* (feat) Add souce code read in pre-build sphinx

* (WIP) Add pre-build comamnd for sphinx-api

* (WIP) Test run command on git actions

* (feat) Add pre-build source code

* (fix) Fix doc to docs

* (fix) Fix pre-build rm command

* (fix) Remove firefox pop-up and latex build

* (feat) Add install dependancies for sphinx

* (feat) Upload artifacts for the html documentation

* (feat) Add pages deploy

* (feat) upload artifacts

* (fix) Correct artifact path

* (fix) Correct publish_dir

* (feat) Add Manual push to gh-pages

* (refactor) Remove autoDocs.yml

* (refactor) Remove comment from createDocumentation

* Squashed commit of the following:

commit f35355a
Merge: fbb7d23 339ce03
Author: sahilbhola14 <sbhola@umich.edu>
Date:   Tue Nov 29 19:51:59 2022 -0500

    Merge branch 'main' of github.com:PinguDevTeam/ICF-MI-framework into main

commit fbb7d23
Merge: 90ec97b 8b8c071
Author: sahilbhola14 <sbhola@umich.edu>
Date:   Mon Nov 28 14:43:07 2022 -0500

    Merge branch 'main' of github.com:PinguDevTeam/ICF-MI-framework into main

* (fix) Add source code path to conf

Co-authored-by: sahilbhola14 <sbhola@umich.edu>
This function will be used for new data assimilation
This function will be useful to retrieve full tensors
This function updates TT-ranks after incremental updates
Given a new tensor, this function computes the relative projection error
Given an original tensor, this function
reconstructs the corresponding tensor from TT-cores and
computes the relative reconstruction error
This function computes the TT-decomposition using the TTSVD algorithm
This function computes the TT-decomposition using utils.ttsvd
This function computes the error truncated SVD for TT-ICE and TT-ICE*
This function computes the TT-decomposition incrementally using
TT-ICE algorithm
This function computes the TT-decomposition incrementally using
TT-ICE* algorithm
This python script compresses the ICF simulation outputs
and saves the resulting TT-cores
@dorukaks dorukaks marked this pull request as ready for review December 13, 2022 17:31
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request TT-ICE Everything related to TT-ICE
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[TODO] TT-ICE Library documentation [TODO] Modify existing TT-ICE package [TODO] Transfer TT-ICE codebase
1 participant