search

taichi-dev / taichi

Productive, portable, and performant GPU programming in Python.
https://taichi-lang.org
Apache License 2.0
25.51k stars 2.28k forks source link

[doc] A quick reference of Taich APIs is absent #4100

Open turbo0628 opened 2 years ago

turbo0628 commented 2 years ago

I think there should be a quick language API reference, which can help users retrieve their desired API interface.

This can be a reference table, or API index map. For reference, I use the tmux cheat sheet (https://tmuxcheatsheet.com/) quite often. Can we write something similar for Taichi?

k-ye commented 2 years ago

Wonder if the LSP proposal could partially solve this problem.. @rexwangcc

rexwangcc commented 2 years ago

Wonder if the LSP proposal could partially solve this problem.. @rexwangcc

I'm not sure. It seems this issue is proposing an "atlas" like "Taichi common API/func Cheat Sheet" (similar to the tmux one or maybe even more comprehensive as https://www.rstudio.com/resources/cheatsheets/), which I believe could be quite helpful to folks want to quickly know which APIs are capable of doing what; while LSP only helps devs who already know which set of APIs they gonna use but need to look up the details.