mirror of
https://github.com/NicolasBohn/NexQuant.git
synced 2026-08-07 20:17:45 +00:00
Document in High-level (#93)
* Add init information * Adjust order and move content * GPU support * edit docs * README structure * Update Dockerfile * Update rdagent/utils/env.py * Update read the docs * Update framework
This commit is contained in:
+59
-7
@@ -2,17 +2,69 @@
|
||||
For Development
|
||||
=========================
|
||||
|
||||
title1
|
||||
🔧Prepare for development
|
||||
=========================
|
||||
|
||||
content1
|
||||
- Set up the development environment.
|
||||
|
||||
title2
|
||||
```bash
|
||||
make dev
|
||||
```
|
||||
|
||||
- Run linting and formatting.
|
||||
|
||||
```bash
|
||||
make lint
|
||||
```
|
||||
|
||||
|
||||
Code Structure
|
||||
=========================
|
||||
|
||||
content2
|
||||
.. code-block:: text
|
||||
|
||||
title3
|
||||
=========================
|
||||
📂 src
|
||||
➥ 📂 <project name>: avoid namespace conflict
|
||||
➥ 📁 core
|
||||
➥ 📁 components/A
|
||||
➥ 📁 components/B
|
||||
➥ 📁 components/C
|
||||
➥ 📁 scenarios/X
|
||||
➥ 📁 scenarios/Y
|
||||
➥ 📂 app
|
||||
➥ 📁 scripts
|
||||
|
||||
content3
|
||||
.. list-table::
|
||||
:header-rows: 1
|
||||
|
||||
* - Folder Name
|
||||
- Description
|
||||
* - 📁 core
|
||||
- The core framework of the system. All classes should be abstract and usually can't be used directly.
|
||||
* - 📁 component/A
|
||||
- Useful components that can be used by others (e.g., scenarios). Many subclasses of core classes are located here.
|
||||
* - 📁 scenarios/X
|
||||
- Concrete features for specific scenarios (usually built based on components or core). These modules are often unreusable across scenarios.
|
||||
* - 📁 app
|
||||
- Applications for specific scenarios (usually built based on components or scenarios). Removing any of them does not affect the system's completeness or other scenarios.
|
||||
* - 📁 scripts
|
||||
- Quick and dirty things. These are candidates for core, components, scenarios, and apps.
|
||||
|
||||
|
||||
|
||||
Conventions
|
||||
===========
|
||||
|
||||
|
||||
File Naming Convention
|
||||
----------------------
|
||||
|
||||
.. list-table::
|
||||
:header-rows: 1
|
||||
|
||||
* - Name
|
||||
- Description
|
||||
* - `conf.py`
|
||||
- The configuration for the module, app, and project.
|
||||
|
||||
<!-- TODO: renaming files -->
|
||||
|
||||
Reference in New Issue
Block a user