-
Notifications
You must be signed in to change notification settings - Fork 2.3k
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.
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
[Example] Refactor example library #2475
[Example] Refactor example library #2475
Conversation
@yuanming-hu and I agreed that all examples in the Taichi main repo should be self-contained. The goal of examples is to provide high-quality reference code snippets for new users to learn Taichi, so ideally examples would aim to be as concise and clear as possible. Of course, introducing libraries will make the code even clearer ( |
I strongly agree that examples serve as the facade of a programming language. Examples should, at the very least,
Many of the current examples do not satisfy these criteria and need to be removed (or moved to advanced examples after polishment). For example, I believe @victoriacity and I will schedule a meeting to walk through all the examples. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Just one nit :-)
/format |
Just a reminder that once #2494 is merged we should (and also make it clear to developers of the main repo) use this repo, not the docs repo as the source of truth of the documentation. The docs repo will become a mirrorred-content hosting repo + translations hub and only be updated if there are functional changes to the docsite itself. |
A substantial amount of example programs have been added into Taichi since the past year. With a well-organized
examples/
directory and adequate documentation for the example programs, not only can users have a clearer idea of Taichi's capabilities by navigating through and playing with the examples, but also will adding and reviewing new examples become more standardized.This PR will introduce the following changes to the
examples/
directory and documentation:mass_spring_3d
andrun without dependencies while these two exceptions requiretree_gravity
taichi_three
andtaichi_glsl
packages.examples/algorithms
: Fundamental algorithms and data structures (MGPCG, spatial data structures, etc)examples/chi_examples
: Examples of CHI IRexamples/features
: Features of Taichi compiler and frontend, including sparse computing, IO and GUI .examples/ml
: Machine learning and differentiable computingexamples/rendering
: Rendering methodsexamples/simulation
: Physical simulationsti
executableDocumentation for examples and adding new examples(per [Doc] Remove all .rst docs #2492, this will be addressed separately due to ongoing documentation updates)This PR is in draft stage and should not change anything out of the
ti
executable script,examples/
anddocs/
directories. Inputs are welcome!