You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-11Lines changed: 16 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,10 +35,25 @@ TensorCircuit-NG is the only actively maintained official version and a [fully c
35
35
36
36
Please begin with [Quick Start](/docs/source/quickstart.rst) in the [full documentation](https://tensorcircuit-ng.readthedocs.io/).
37
37
38
-
For more information on software usage, sota algorithm implementation and engineer paradigm demonstration, please refer to 100+ [example scripts](/examples) and 40+ [tutorial notebooks](https://tensorcircuit-ng.readthedocs.io/en/latest/#tutorials). API docstrings and test cases in [tests](/tests) are also informative. One can also refer to AI-native docs for tensorcircuit-ng: [Devin Deepwiki](https://deepwiki.com/tensorcircuit/tensorcircuit-ng) and [Context7 MCP](https://context7.com/tensorcircuit/tensorcircuit-ng).
38
+
For more information on software usage, sota algorithm implementation and engineer paradigm demonstration, please refer to 130+ [example scripts](/examples) and 40+ [tutorial notebooks](https://tensorcircuit-ng.readthedocs.io/en/latest/#tutorials). API docstrings and test cases in [tests](/tests) are also informative. One can also refer to AI-native docs for tensorcircuit-ng: [Devin Deepwiki](https://deepwiki.com/tensorcircuit/tensorcircuit-ng) and [Context7 MCP](https://context7.com/tensorcircuit/tensorcircuit-ng).
39
39
40
40
For beginners, please refer to [quantum computing lectures with TC-NG](https://github.com/sxzgroup/qc_lecture) to learn both quantum computing basics and representative usage of TensorCircuit-NG.
41
41
42
+
### AI-Assisted Development (Recommended)
43
+
44
+
To write TC-NG scripts and applications efficiently with AI coding agents (e.g., Claude Code, Cursor, Antigravity), we strongly recommend **working directly within the local tensorcircuit-ng repository** rather than an empty folder.
45
+
46
+
1.**Rich Context:** The 100+ scripts in `examples/` and extensive test cases in `tests/` provide essential references that significantly reduce AI hallucinations.
47
+
2.**Built-in Rules:** We provide a dedicated **[`llm.md`](/llm.md)** file. It serves as the "handbook" (i.e. `CLAUDE.md`) for AI agents, defining coding standards and best practices to ensure the generated code is idiomatic.
48
+
49
+
**Recommended Workflow:**
50
+
51
+
1. Clone the repository: `git clone https://github.com/tensorcircuit/tensorcircuit-ng.git`
52
+
2. Switch to a local playground branch: `git checkout -b my-playground` in case messing up with the original repository.
53
+
3. Open the repository folder in your AI IDE. And you are ready to start writing TC-NG scripts.
54
+
55
+
Now, enjoy implementing quantum algorithms entirely through natural language.
56
+
42
57
The following are some minimal demos.
43
58
44
59
- Circuit construction:
@@ -162,13 +177,11 @@ We also have [Docker support](/docker).
162
177
- HPC native, distributed simulation enabled, multiple devices/hosts support
163
178
164
179
- Efficiency
165
-
166
180
- Time: 10 to 10^6+ times acceleration compared to TensorFlow Quantum, Pennylane or Qiskit
0 commit comments