Skip to content

Tutorials and documentation updates #104

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 35 commits into from
Aug 4, 2025
Merged

Tutorials and documentation updates #104

merged 35 commits into from
Aug 4, 2025

Conversation

faberga
Copy link
Collaborator

@faberga faberga commented Jul 10, 2025 •
edited
Loading

Proposed changes

Documentation updates: This PR mainly reorganizes the instructions on how to build the Program Mapper and Functional Modeler, and adds the trace files for the tutorials. Readme.md files for the tutorials will be added on a separate PR.

Types of changes

What types of changes does your code introduce to the Encrypted Computing SDK project?
Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating
the PR. If you are unsure about any of them, do not hesitate to ask. We are
here to help! This is simply a reminder of what we are going to look for before
merging your code.

  • I have read the CONTRIBUTING agreement
  • Current formatting and unit tests / base functionality passes locally with my changes
  • I have added tests that prove my fix is effective or that my feature works (if appropriate)
  • I have added necessary documentation (if appropriate)
  • Any dependent changes have been merged and published in downstream modules

Further comments

Readme.md files for the tutorials will be added on a separate PR.

faberga and others added 19 commits June 25, 2025 09:30
@faberga
Update top level README.md
f4e97d0 
Add text updates plus link to quick start.
@faberga
Create top level P-ISA README.md file
f15e451 
Concatenating the  program mapper and functional modeler build instructions at top level P-ISA Tools directory
@faberga
Updates to P-ISA top level README.md
1071299 
Added hoot run functional modeler
@faberga
Updates to the P-ISA top level README.md file
742fe92
@faberga
Updates to P-ISA top level README.md file
b6b6a33 
Additional formatting
@faberga
Create empty_file.txt
4c6b327
@faberga
Create P-ISA tutorial README.md
19ed542
@faberga
Empty functional modeler README.md
edeb95d 
Content has been concatenated into the top level P-ISA Tools README.md file.
@faberga
Empty program mapper README.md file
6722349 
Content has been concatenated into the top level P-ISA Tools README.md file.
@faberga
Update p-ias-tools tutorial README.md
3ebb8d9
@faberga
Update P-ISA Tutorial README.md file
531d5e0
@faberga
first single ops trace file
999a3b7
@faberga
Upload examples of the single ops traces
2b356f3
@faberga
Create empty_file.txt
645dbe6
@faberga
Delete tutorials/p-isa-tools/the_complex_single_ops directory
dbb6014
@faberga
Create empty_file.txt
bbe8650
@faberga
Create empty_file.txt
64f7168
@faberga
Trace files - complex single FHE ops
e37ed41
@faberga
Trace files - multi FHE ops
0ebe8be
@faberga faberga self-assigned this Jul 10, 2025
joserochh
joserochh requested changes Jul 10, 2025
View reviewed changes
Copy link
Contributor

@joserochh joserochh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please make sure to install pre-commit and pre-commit hooks prior to committing.

faberga
faberga commented Jul 10, 2025
View reviewed changes
faberga
faberga commented Jul 29, 2025
View reviewed changes
faberga
faberga commented Jul 29, 2025
View reviewed changes
faberga
faberga commented Jul 29, 2025
View reviewed changes
@faberga
Copy link
Collaborator Author

faberga commented Jul 29, 2025 •
edited
Loading

Hi @joserochh,
The pre-commit 'typos' has been giving a failure when running on the GitHub CI, but not when I run it locally on my machine. So, I added the --dif argument to try to find which file may contain a typo, and now the typos check passes.

Can you try on your system, pls?

@faberga faberga requested a review from joserochh July 29, 2025 17:32
@faberga faberga marked this pull request as ready for review July 29, 2025 17:36
@faberga faberga requested a review from kylanerace July 29, 2025 17:36
christopherngutierrez
christopherngutierrez approved these changes Jul 29, 2025
View reviewed changes
Copy link
Contributor

@christopherngutierrez christopherngutierrez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, updated documentation.

  • Moved readme.md content from subdirs to p-isa_tools/README.md
  • Project name changed to Encrypted Computing SDK
  • Reworded a few sentences
  • Added traces

@faberga faberga mentioned this pull request Jul 30, 2025
Merged
kylanerace
kylanerace approved these changes Jul 30, 2025
View reviewed changes
Copy link
Collaborator

@kylanerace kylanerace left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, examples traces fixed

@kylanerace
Copy link
Collaborator

Confirming that this PR should be good to go? @faberga

@faberga
Copy link
Collaborator Author

faberga commented Aug 4, 2025

@kylanerace , yes it is good to go.
I'm waiting for it to be in to start populating the rest of the tutorial.

Thanks

@kylanerace kylanerace merged commit 8edca51 into main Aug 4, 2025
6 checks passed
@kylanerace kylanerace deleted the flavio/Docs-n-Tutorials branch August 4, 2025 21:32
@faberga
Copy link
Collaborator Author

faberga commented Aug 4, 2025

@kylanerace Thank you.

christopherngutierrez pushed a commit that referenced this pull request Sep 18, 2025
@faberga @joserochh @christopherngutierrez
Tutorials and documentation updates (#104)
e4b5806 
* Update top level README.md

Add text updates plus link to quick start.

* Create top level P-ISA README.md file 

Concatenating the  program mapper and functional modeler build instructions at top level P-ISA Tools directory

* Updates to P-ISA top level  README.md

Added hoot run functional modeler

* Updates to the P-ISA top level  README.md file

* Updates to P-ISA top level README.md file

Additional formatting

* Create empty_file.txt

* Create P-ISA tutorial README.md

* Empty functional modeler README.md

Content has been concatenated into the top level P-ISA Tools README.md file.

* Empty program mapper README.md file

Content has been concatenated into the top level P-ISA Tools README.md file.

* Update p-ias-tools tutorial README.md

* Update P-ISA Tutorial README.md file

* first single ops trace file

* Upload examples of the single ops traces

* Create empty_file.txt

* Delete tutorials/p-isa-tools/the_complex_single_ops directory

* Create empty_file.txt

* Create empty_file.txt

* Trace files - complex single FHE ops

* Trace files - multi FHE ops

* Formating changes to README.md

* Removing empty files

* Removing empty files

* Remove empty files

* Update README.md

Fix typo and formating

* Update CONTRIBUTING.md

* fix typo in  p-isa_tools/README.md

* Fix typo in trace files

Fix typo in the header line of the trace files

* Fix for typos in the header line of FHE Single Ops traces

* Fix trailing spaces and punctuation

* Fix typos

* Fix Typos

* Set diff flag for typos in  .pre-commit-config.yaml

---------

Co-authored-by: Jose Rojas Chaves <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joserochh joserochh joserochh approved these changes

@kylanerace kylanerace kylanerace approved these changes

@christopherngutierrez christopherngutierrez christopherngutierrez approved these changes

Assignees

@faberga faberga

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@faberga @kylanerace @joserochh @christopherngutierrez