pyaimopt：AIM优化服务的Python包装器

pyaimopt是一个提供对Analog Iterative Machine (AIM) 优化服务访问的包。 AIM优化器接受二次无约束混合优化 (QUMO) 格式的 problèmes。 QUMO 格式是二次无约束二元优化 (QUBO) 格式的推广，并允许优化连续变量以及二元变量。 AIM优化器是一种随机优化算法，它使用梯度下降和退火相结合的方法来寻找给定目标函数的全局最小值。除了 QUMO 和 QUBO 问题外，AIM优化器还可以用于解决 MaxCut 和 Ising 问题。

目录

• pyaimopt：AIM优化服务的Python包装器
  • 目录
  • 先决条件
  • 安装
  • 身份验证和API密钥
  • 使用示例
  • 文档
  • 贡献
  • 许可证
  • 联系方式

先决条件

该包需要Python 3.10或更高版本。建议使用虚拟环境安装该包。

安装

要安装pyaimopt，只需使用pip

pip install pyaimopt -i https://msr-optics.pkgs.visualstudio.com/OpticalCompute/_packaging/OpticalCompute/pypi/simple/

您可以通过运行以下命令来检查安装是否成功

aim status

它应该返回已安装包的版本和AIM服务的状态。

待办事项：带有传递API密钥的示例。

身份验证和API密钥

待办事项：添加获取API密钥的说明。这应由AIM团队完成。

待办事项：解释如何将API密钥传递给包。

待办事项：解释替代身份验证方法。

使用示例

要开始使用，您可以使用以下命令提交一个简单的QUMO问题到AIM优化器，检查提交的问题状态，并检索结果。

aim submit
# This returns: "Submitted job <job_id>"
aim list
# The output should contain the <job_id> of the submitted job and its status
# Upon completion, the status should be "Completed"
aim retrieve <job_id>
# This returns the results of the optimization

待办：添加使用同步接口提交简单QUMO问题的示例。

待办：添加使用异步接口的示例。

待办：提及包含示例的GitHub仓库。

文档

待办：添加链接到文档。

贡献

欢迎贡献力量！

待办：添加贡献示例的说明。

待办：添加报告错误和提出新功能的说明。

待办：添加对求解器提出更改的建议。

许可证

此软件包在MS-PL许可证下发布。有关更多信息，请参阅LICENSE文件。

此软件包依赖于多个外部包。这些包的列表及其相应的许可证可以在NOTICE.html文件中找到。

联系方式

有关与AIM优化器的功能或特性相关的问题或评论，请在AIM GitHub仓库上创建一个问题。

要获取访问服务的权限，请联系AIM 团队。目前，此服务仅对选定用户开放。

有关进一步的问题或评论，请联系AIM 团队。

待办：添加到问题页面的链接。