Solid 是一个用于无梯度优化的 Python 框架。

它包含了多种最常见的【无需计算梯度的优化算法】的基本实现，并且允许用户非常快速地基于这些算法进行开发。

这是一个非常通用的库，非常适合学习、修改，当然也适合直接开箱即用。

详细文档请见 这里。

---

当前功能：

• 遗传算法
• 进化算法
• 模拟退火
• 粒子群优化
• 禁忌搜索
• 和声搜索
• 随机爬山法

---

使用方法：

• pip install solidpy
• 导入所需的算法
• 创建一个继承自该算法的类，并实现必要的抽象方法
• 调用其 .run() 方法，该方法始终返回最佳解及其目标函数值

---

示例：

from random import choice, randint, random
from string import lowercase
from Solid.EvolutionaryAlgorithm import EvolutionaryAlgorithm


class Algorithm(EvolutionaryAlgorithm):
    """
    尝试让一个随机生成的字符串匹配字符串 "clout"
    """
    def _initial_population(self):
        return list(''.join([choice(lowercase) for _ in range(5)]) for _ in range(50))

    def _fitness(self, member):
        return float(sum(member[i] == "clout"[i] for i in range(5)))

    def _crossover(self, parent1, parent2):
        partition = randint(0, len(self.population[0]) - 1)
        return parent1[0:partition] + parent2[partition:]

    def _mutate(self, member):
        if self.mutation_rate >= random():
            member = list(member)
            member[randint(0,4)] = choice(lowercase)
            member = ''.join(member)
        return member


def test_algorithm():
    algorithm = Algorithm(.5, .7, 500, max_fitness=None)
    best_solution, best_objective_value = algorithm.run()

---

测试

要运行测试，请查看 tests 文件夹。

使用 pytest；它应该能够自动找到测试文件。

---

贡献

如果您想添加任何功能或发现 bug，请随时提交 pull request。

您可以在 issues 标签页中查看一些潜在的待办事项。

Solid 快速上手指南

Solid 是一个用于无梯度优化（Gradient-free Optimization）的 Python 框架。它内置了遗传算法、模拟退火、粒子群优化等多种经典算法，无需计算目标函数的导数即可进行优化，非常适合黑盒优化问题、参数调优及算法学习。

环境准备

• 操作系统：Linux, macOS, Windows
• Python 版本：建议 Python 3.6 及以上
• 前置依赖：
  • pip (Python 包管理工具)
  • pytest (可选，仅用于运行测试)

国内加速建议：推荐使用清华或阿里镜像源安装依赖，以提升下载速度。

安装步骤

使用 pip 直接安装官方发布版本：

pip install solidpy

若需使用国内镜像加速安装：

pip install solidpy -i https://pypi.tuna.tsinghua.edu.cn/simple

基本使用

Solid 的使用核心在于继承特定的算法类，并实现其抽象方法（如初始化种群、适应度函数、交叉变异等），最后调用 .run() 方法获取最优解。

以下是一个基于进化算法（Evolutionary Algorithm）的完整示例，目标是让随机生成的字符串匹配目标字符串 "clout"：

from random import choice, randint, random
from string import lowercase
from Solid.EvolutionaryAlgorithm import EvolutionaryAlgorithm


class Algorithm(EvolutionaryAlgorithm):
    """
    尝试让随机生成的字符串匹配目标字符串 "clout"
    """
    def _initial_population(self):
        # 初始化种群：生成 50 个长度为 5 的随机小写字母字符串
        return list(''.join([choice(lowercase) for _ in range(5)]) for _ in range(50))

    def _fitness(self, member):
        # 适应度函数：计算与目标字符串 "clout" 字符匹配的数量
        return float(sum(member[i] == "clout"[i] for i in range(5)))

    def _crossover(self, parent1, parent2):
        # 交叉操作：随机选择一个切分点进行基因重组
        partition = randint(0, len(self.population[0]) - 1)
        return parent1[0:partition] + parent2[partition:]

    def _mutate(self, member):
        # 变异操作：根据变异率随机改变某个字符
        if self.mutation_rate >= random():
            member = list(member)
            member[randint(0, 4)] = choice(lowercase)
            member = ''.join(member)
        return member


def test_algorithm():
    # 初始化算法实例
    # 参数依次为：变异率，交叉率，最大迭代次数，最大适应度阈值
    algorithm = Algorithm(.5, .7, 500, max_fitness=None)
    
    # 运行优化
    best_solution, best_objective_value = algorithm.run()
    
    print(f"最佳解：{best_solution}")
    print(f"适应度值：{best_objective_value}")

if __name__ == "__main__":
    test_algorithm()

核心流程说明：

1. 导入算法：从 Solid 模块导入所需的算法类（如 EvolutionaryAlgorithm, ParticleSwarm 等）。
2. 定义子类：创建继承类并重写必要的抽象方法（_initial_population, _fitness, _crossover, _mutate 等，具体取决于所选算法）。
3. 实例化与运行：传入超参数实例化对象，调用 .run() 方法。
4. 获取结果：.run() 返回两个值：best_solution（最优解）和 best_objective_value（对应的目标函数值）。