Skip to content

Add Tutorial and Refactor README #97

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
Xeratec merged 7 commits into from
Jul 1, 2025
Merged

Add Tutorial and Refactor README #97

Xeratec merged 7 commits into from
Jul 1, 2025

Conversation

@Victor-Jung
Copy link
Member

@Victor-Jung Victor-Jung commented Jun 18, 2025 •
edited by Xeratec
Loading

The intend is the title.

Added

  • A Deeploy Logo :)
  • A tutorial from the SoCDAML Exercise given this summer at ETH.

Changed

  • Improve the verbosity of the description of memory size CLI args
  • Update README Getting Started with new platforms Adder test command
  • Move License at the bottom of README, and move Documentation at the top
  • Refactor the Supported Platforms into a table

PR Merge Checklist

  1. The PR is rebased on the latest devel commit and pointing to devel.
  2. Your PR reviewed and approved.
  3. All checks are passing.
  4. The CHANGELOG.md file has been updated.
  5. If the docker was modified, change back its link after review.

@Victor-Jung Victor-Jung added this to the Release 0.2.0 milestone Jun 18, 2025
@Victor-Jung Victor-Jung self-assigned this Jun 18, 2025
@Victor-Jung Victor-Jung added the Documentation Improvements or additions to documentation label Jun 18, 2025
@Victor-Jung Victor-Jung marked this pull request as ready for review June 18, 2025 07:02
@Victor-Jung Victor-Jung requested a review from Xeratec as a code owner June 18, 2025 07:02
@Victor-Jung Victor-Jung moved this to In review in Deeploy Jun 18, 2025
Xeratec
Xeratec requested changes Jun 19, 2025
View reviewed changes
Copy link
Member

@Xeratec Xeratec left a comment

Choose a reason for hiding this comment

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

Looks good, but I argue that the Tutorial should be integrated into the Sphinx documentation, as the required effort is small. I offer to take this over.

@Xeratec Xeratec moved this from In review to In progress in Deeploy Jun 19, 2025
@Xeratec
Copy link
Member

Xeratec commented Jun 30, 2025

I implemented my suggested changes and pushed one more commit to improve the visual appearance of the documentation with a logo. Unfortunately, the documentation stage fails as the Docker container does not yet include the sphinx_favicon pip dependency. I already added it in the requirements-dev.txt file, but we would need to rebuild the container. I tested it locally, and it should work.

image

I think we could take the risk and merge it, rebuild the container, and rerun the tests on devel. The worst case is that the documentation will break, which is not super bad. @Victor-Jung let me know what you think.

@Xeratec Xeratec force-pushed the socdaml-exercise branch from ec662df to 064a48c Compare June 30, 2025 15:49
@Xeratec Xeratec moved this from In progress to Ready for Merge in Deeploy Jun 30, 2025
@Xeratec Xeratec moved this from Ready for Merge to In review in Deeploy Jun 30, 2025
@Xeratec Xeratec mentioned this pull request Jun 30, 2025
Merged
5 tasks
@Victor-Jung
Copy link
Member Author

Victor-Jung commented Jun 30, 2025

I think we could take the risk and merge it, rebuild the container, and rerun the tests on devel. The worst case is that the documentation will break, which is not super bad. @Victor-Jung let me know what you think.

The optimal flow is that you build a new container on your fork based on this branch and run the CI on it (using the smart input field). Then you can point the reviewer to the action working with your Docker. For this specific case, I agree that we can 'trust' that this small change is okay, worst case, we hotfix.

Beautiful doc btw! 😁

Victor-Jung
Victor-Jung commented Jun 30, 2025
View reviewed changes
Copy link
Member Author

@Victor-Jung Victor-Jung left a comment

Choose a reason for hiding this comment

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

LGTM! Since I'm the PR author you can self approve the PR ;D

@Xeratec Xeratec merged commit 73542af into pulp-platform:devel Jul 1, 2025
116 of 117 checks passed
@github-project-automation github-project-automation bot moved this from In review to Done in Deeploy Jul 1, 2025
@Xeratec
Copy link
Member

Xeratec commented Jul 1, 2025

Ah damn, it actually broke because the documentation CI does not use the requirements-dev.txt but the dependencies specified in .github/workflows/documentation.yml. I am doing a proper CI test on my fork now :D Currently, the CI on devel is also failing because I forgot to first rebuild the toolchain container. This is in progress now.

This was referenced Jul 1, 2025
Merged
Merged
Xeratec added a commit that referenced this pull request Jul 8, 2025
@Xeratec
Release v0.2.0 (#103)
c7fd2a1 
This release contains major architectural changes, new platform support,
enhanced simulation workflows, floating-point kernel support, training
infrastructure for CCT models, memory allocation strategies, and
documentation improvements.

After merging this into `main`, the release process will proceed with:
- Pushing a Git tag for the release after merging this PR
- Creating a GitHub release with the prepared tag.

Note: Since the release tag references the Docker container tagged with
the release tag (`ghcr.io/pulp-platform/deeploy:v0.2.0`), the CI will
initially fail. The Deeploy Docker image must be built after the release
PR is merged and the CI restarted.

### List of Pull Requests
- Prepare v0.2.0 release
[#102](#102)
- Add Luka as Code Owner
[#101](#101)
- Fix CI, Docker Files, and Documentation Workflow
[#100](#100)
- Chimera Platform Integration
[#96](#96)
- Add Tutorial and Refactor README
[#97](#97)
- Reduce Mean Float Template
[#92](#92)
- Reshape Memory Freeing and Generic Float GEMM Fixes
[#91](#91)
- Prepare for Release and Separate Dependencies
[#90](#90)
- Fix input offsets calculation
[#89](#89)
- Move PULP SDK to main branch/fork
[#88](#88)
- Finite Lifetime for IO Tensors
[#51](#51)
- Improved Memory Visualization and Multi-Layer Tiling Profiling
[#56](#56)
- Fix Linting in CI and Reformat C Files
[#86](#86)
- Fix Broken CMake Flow For pulp-sdk
[#87](#87)
- Refactor Changelog For Release
[#85](#85)
- ARM Docker Container and Minor Bug Fix
[#84](#84)
- Added Kernel for Generic Float DW Conv2D
[#63](#63)
- Autoselect Self-Hosted Runners if the Action is on Upstream
[#81](#81)
- TEST_RECENT linking on MacOS
[#78](#78)
- Add RV32IMF Picolibc support for Siracusa platform
[#66](#66)
- Improve Documentation and VSCode Support
[#76](#76)
- Debug Print Topology Pass and Code Transformation
[#75](#75)
- Find all subdirectories of Deeploy when installing with pip install
[#70](#70)
- Add milestone issue template
[#71](#71)
- Bunch of fixes and changes
[#58](#58)
- Add SoftHier platform
[#65](#65)
- rv32imf_xpulpv2 ISA support for Siracusa platform
[#64](#64)
- One LLVM To Compile Them All
[#60](#60)
- One GVSoC to Simulate Them All
[#59](#59)
- Add Support for CCT Last Layer Training with Embedding Dim 8-128
[#55](#55)
- Add CCT Classifier Training Support
[#53](#53)
- L3 Bugs: DMA Struct Datatype and Maxpool Margin Error
[#45](#45)
- DeepQuant Quantized Linear Support
[#54](#54)
- Implemented Dequant Layer for Generic and Siracusa
[#52](#52)
- Infinite Lifetime Buffers Considered in Tiling & Memory Allocation (+
Visualization) [#44](#44)
- Implemented Quant Layer for Generic and Siracusa
[#49](#49)
- Increase maximal Mchan DMA transfer sizes from 64KiB to 128KiB
[#47](#47)
- Add MiniMalloc and Decouple Memory Allocation and Tiling
[#40](#40)
- Float CCT Bugs on L3
[#37](#37)
- Memory Allocation Strategies and Visualization
[#36](#36)
- Add CODEOWNERS [#42](#42)
- Add Tiling Support to All CCT Kernels and Fix CCT Operators on
Siracusa Platform for L2
[#35](#35)
- Add Fp gemm and Softmax for Snitch platform
[#31](#31)
- Add Float Kernels for CCT
[#29](#29)
- documentation deployment
[#34](#34)
- main.c Float Cast Bugs
[#28](#28)
- Add Float GEMM on PULP with Tiling
[#26](#26)
- Add Float Support & Float GEMM for Generic
[#25](#25)
- GVSOC support for the Snitch Cluster platform
[#23](#23)
- Snitch Cluster Tiling Support
[#22](#22)
- Snitch support integration
[#14](#14)
- Update bibtex citation
[#20](#20)
- the PR template location, bump min python to 3.10, change install
command [#17](#17)
- Add pre-commit for python formatting
[#15](#15)
- FP integration (v2)
[#12](#12)
- shell for sequential tests of Generic, Cortex, and Mempool platforms
[#11](#11)
- Add issue templates
[#10](#10)
- Minor CI and Readme Improvements
[#8](#8)
- Fix GHCR Link for Docker Build
[#7](#7)
- neureka's ccache id
[#6](#6)
- GitHub-based CI/CD Flow
[#4](#4)
- Generic Softmax Kernel
[#2](#2)
- Port GitLab CI [#1](#1)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Xeratec Xeratec Xeratec approved these changes

Assignees

@Xeratec Xeratec

@Victor-Jung Victor-Jung

Labels

Documentation Improvements or additions to documentation

Projects

Deeploy
Status: Done

Milestone

Release 0.2.0

Development

Successfully merging this pull request may close these issues.

2 participants

@Victor-Jung @Xeratec