mirror of
https://github.com/NicolasBohn/NexQuant.git
synced 2026-08-05 11:07:43 +00:00
Xinjie Shen
f20dc4482b
* upload example code for model implementation * Refactor Model Implement * add export --------- Co-authored-by: Young <afe.young@gmail.com>
65 lines
2.9 KiB
Markdown
65 lines
2.9 KiB
Markdown
# Project
|
|
|
|
> This repo has been populated by an initial template to help get you started. Please
|
|
> make sure to update the content to build a great experience for community-building.
|
|
|
|
As the maintainer of this project, please make a few updates:
|
|
|
|
- Improving this README.MD file to provide a great experience
|
|
- Updating SUPPORT.MD with content about this project's support experience
|
|
- Understanding the security reporting process in SECURITY.MD
|
|
- Remove this section from the README
|
|
|
|
## Configuration:
|
|
|
|
You can manually source the `.env` file in your shell before running the Python script:
|
|
Most of the workflow are controlled by the environment variables.
|
|
```sh
|
|
# Export each variable in the .env file; Please note that it is different from `source .env` without export
|
|
export $(grep -v '^#' .env | xargs)
|
|
# Run the Python script
|
|
python your_script.py
|
|
```
|
|
|
|
## Naming convention
|
|
|
|
### File naming convention
|
|
|
|
| Name | Description |
|
|
| -- | -- |
|
|
| `conf.py` | The configuration for the module & app & project |
|
|
|
|
<!-- TODO: renaming files -->
|
|
|
|
|
|
## Contributing
|
|
|
|
### Guidance
|
|
This project welcomes contributions and suggestions.
|
|
You can find issues in the issues list or simply running `grep -r "TODO:"`.
|
|
|
|
Making contributions is not a hard thing. Solving an issue(maybe just answering a question raised in issues list ), fixing/issuing a bug, improving the documents and even fixing a typo are important contributions to RDAgent.
|
|
|
|
|
|
### Policy
|
|
|
|
This project welcomes contributions and suggestions. Most contributions require you to agree to a
|
|
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
|
|
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
|
|
|
|
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
|
|
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
|
|
provided by the bot. You will only need to do this once across all repos using our CLA.
|
|
|
|
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
|
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
|
|
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
|
|
|
## Trademarks
|
|
|
|
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
|
|
trademarks or logos is subject to and must follow
|
|
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
|
|
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
|
|
Any use of third-party trademarks or logos are subject to those third-party's policies.
|