무엇을 정하나요
항목마다 고를지 말지 정합니다.
최소 실행 예제
from optimaru.knapsack import solve
from optimaru.knapsack.models import ItemModel, KnapsackProblemModel
problem = KnapsackProblemModel(
capacity=10,
items=[
ItemModel(id="A", weight=6, value=9),
ItemModel(id="B", weight=4, value=7),
ItemModel(id="C", weight=5, value=8),
],
)
print(solve(problem, time_limit_seconds=1.0, random_seed=42)) # Score를 돌려주고 그 자리에서 풉니다
print([item.id for item in problem.items if item.selected], problem.total_value) 같은 유스케이스를 그림과 실행 결과가 담긴 Jupyter 노트북으로도 볼 수 있습니다. examples/knapsack.ipynb ↗
입력 파라미터
ItemModel
| 필드 | 의미 |
|---|
id 필수 입력 weight 필수 입력 capacity에 들어가는 무게입니다.value 필수 입력 resource_ usage requires SelectionGroupModel
| 필드 | 의미 |
|---|
id 필수 입력 item_ ids 필수 입력 min_ selected max_ selected KnapsackProblemModel
| 필드 | 의미 |
|---|
capacity 필수 입력 items 필수 입력 resource_ capacities mandatory_ items forbidden_ items selection_ groups 풀이 파라미터
풀이를 호출할 때 넘기는 값입니다. 시간 제한, 시드, 병렬 수가 여기에 있습니다.
| 파라미터 | 기본값 | 의미 |
|---|---|---|
time_ | None | 탐색 시간(초)이며, 0부터 1e9까지 줄 수 있습니다. 지정하지 않으면 설정의 spent_limit_seconds를 쓰며, 기본값은 30입니다. |
random_ | None | 탐색에 쓰는 난수 시드입니다. 지정하지 않으면 설정값을 쓰며, 기본값은 0입니다. |
parallel_ | None | 독립적으로 동시에 돌리는 탐색 수입니다. 탐색마다 시드가 다르고 시간은 똑같이 쓰며, 가장 좋은 결과를 고릅니다. 지정하지 않으면 설정값을 쓰며, 기본값은 1입니다. |
stop_ | False | 필수 점수가 0이 되는 즉시 멈춥니다. |
on_ | None | 새 최고 해를 찾을 때마다 부르는 콜백입니다. 콜백이 예외를 내면 풀이를 멈추고 그 예외를 그대로 냅니다. |
config | None | 기본으로 쓸 SolverConfig입니다. 여기서 준 키워드 인자는 이번 풀이에만 이 값을 덮어쓰며, 넘긴 객체 자체는 바뀌지 않습니다. |
constraints | None | 점수에 넣을 제약과 그 설정입니다. 지정하지 않으면 기본 제약을 씁니다. |
탐색 옵션 전체 (25)
SolverConfig에 값을 넣어 config=로 넘기세요.
| 파라미터 | 기본값 | 의미 |
|---|---|---|
best_ | — | 최고 점수가 이 값에 닿으면 일찍 멈춥니다. 기본값으로는 작동하지 않습니다. |
change_ | 0.5 | 변경 이동의 상대적 비중입니다. 0이면 쓰지 않습니다. |
descent_ | 0.0 | 최선 개선 하강의 비중입니다. 0이면 끕니다. |
full_ | False | 증분 점수를 전체 재계산과 매번 비교합니다. 느리므로 디버깅할 때만 씁니다. |
late_ | 0 | 늦은 수락(late acceptance) 기록의 길이입니다. 0이면 문제 크기에 맞춰 정합니다. |
nearby_ | 0.0 | 이동 상대를 가까운 항목에서 고를 확률입니다. 0이면 쓰지 않습니다. |
nearby_ | 20 | 항목마다 유지할 이웃 수입니다. 0의 의미는 유스케이스마다 달라 자동 선택이거나 끄는 값입니다. |
on_ | None | 새 최고 해를 찾을 때마다 부르는 콜백입니다. 콜백이 예외를 내면 풀이를 멈추고 그 예외를 그대로 냅니다. |
parallel_ | 1 | 독립적으로 동시에 돌리는 탐색 수입니다. 탐색마다 시드가 다르고 시간은 똑같이 쓰며, 가장 좋은 결과를 고릅니다. |
random_ | 0 | 탐색에 쓰는 난수 시드입니다. |
ruin_ | True | 탐색이 정체되면 적응형 파괴·재구성을 실행합니다. |
ruin_ | 12 | 그 작은 파괴로 제거할 최대 항목 수입니다. |
ruin_ | 0.05 | 한 걸음을 작은 파괴·복구로 쓰고 일반 이동처럼 판단할 확률입니다. 음수는 지원하는 유스케이스에서 자동 선택이고, 0이면 끕니다. |
ruin_ | 60 | 한 번에 제거하는 항목 수의 절대 상한입니다. |
ruin_ | 0.3 | 한 번에 제거하는 해의 최대 비율입니다. |
ruin_ | 0.1 | 한 번에 제거하는 해의 최소 비율입니다. |
ruin_ | 0.8 | 연산자 가중치가 적응하는 속도입니다. |
ruin_ | 5000 | 실행 후 다듬는 언덕 오르기 이동 수입니다. step_count_limit에는 세지 않습니다. |
ruin_ | [33.0, 9.0, 3.0, 0.0] | 새 최고, 개선, 수락, 거절 결과에 주는 연산자 보상입니다. |
ruin_ | 5000 | 파괴·재구성을 실행하기까지 새 최고 해 없이 지나는 걸음 수입니다. |
spent_ | 30.0 | 탐색 시간(초)이며, 0부터 1e9까지 줄 수 있습니다. |
step_ | 0 | 이 걸음 수에 도달하면 멈춥니다. 0이면 제한이 없습니다. |
swap_ | 0.5 | 교환 이동의 상대적 비중입니다. 0이면 쓰지 않습니다. |
unimproved_ | 0.0 | 새 최고 해 없이 이 시간(초)이 지나면 멈춥니다. 0이면 제한이 없습니다. |
unimproved_ | 0 | 새 최고 해 없이 이 걸음 수가 지나면 멈춥니다. 0이면 제한이 없습니다. |
돌아오는 결과
solve는 problem을 그 자리에서 채우고 엔진 Score를 돌려줍니다. 값은 .hard와 .soft로 읽습니다. problem.to_core()로 만든 엔진 객체도 받습니다.
ItemModel
| 필드 | 의미 |
|---|
selected KnapsackProblemModel
| 필드 | 의미 |
|---|
total_ weight total_ value score_ hard score_ soft 제약
optimaru.knapsack.constraints에서 클래스를 가져와 KnapsackCapacityCost()처럼 호출해서 넘깁니다. 넘긴 제약만 점수에 들어가고, 아무것도 넘기지 않으면 기본 제약을 씁니다. 목록에 같은 제약을 여러 번 넣을 수 있으며, 넣은 것마다 따로 점수에 들어갑니다. 제약마다 다음 파라미터를 받습니다.
| 파라미터 | 기본값 | 의미 |
|---|---|---|
weight | None | 제약 비용에 곱하는 값이며, 적용되는 수준의 단위로 셉니다. 지정하지 않으면 아래 기본 가중치를 씁니다. 기본 가중치가 0인 제약은 가중치를 줘야 작동합니다. |
level | None | "hard"면 필수, "soft"면 선호로 바꿉니다. Level.HARD, Level.SOFT도 됩니다. 지정하지 않으면 아래 수준을 그대로 씁니다. 이 유스케이스에는 중간 수준이 없어서 "medium"을 주면 ValueError가 납니다. 보상에 "hard"를 주거나 수준이 고정된 제약의 수준을 바꾸려 해도 ValueError가 납니다. |
exponent | 1.0 | 부호를 유지한 채 비용에 거듭제곱을 적용하며, 0보다 커야 합니다. offset을 반영한 뒤에 적용합니다. 2.0이면 제곱이라 한곳에 몰린 위반의 비용이 크게 늘어납니다. 차량이나 날짜 같은 단위마다 적용하고, 합계 하나로 계산하는 제약에는 그 합계에 적용합니다. |
offset | 0.0 | 거듭제곱 전에 비용 x에서 빼는 값입니다. exponent처럼 단위마다, 합계로 계산하는 제약은 그 합계에 적용하며, 비용과 같은 척도(초, 분, 개수 등)로 셉니다. 부호와 상관없이 유한한 수면 되고, 키워드로만 줄 수 있습니다. 이 값 아래에서 어떻게 계산할지는 clip이 정합니다. |
clip | True | True면 offset을 문턱값으로 씁니다. 넘은 부분만 계산하므로(max(0, x - offset) ** exponent) 그 이하의 비용은 아무것도 더하지 않습니다. False면 부호를 유지한 채 (x - offset) ** exponent를 그대로 계산하므로, 오프셋보다 작은 단위는 비용이 0이어도 음수, 곧 보상으로 들어갑니다. 하드 점수에 들어가는 수준에서는 clip=False에 0이 아닌 오프셋을 주면 ValueError가 납니다. 하드 0이 위반 없음이라는 뜻을 지키기 위해서입니다. 키워드로만 줄 수 있습니다. |
위의 최소 실행 예제에 이어서 실행합니다.
from optimaru.knapsack.constraints import (
KnapsackCapacityCost, MandatoryItemsCost, SelectedValueCost,
)
custom = problem.model_copy(deep=True)
print(solve(custom, time_limit_seconds=1.0, random_seed=42, constraints=[
KnapsackCapacityCost(), MandatoryItemsCost(), SelectedValueCost(weight=2),
])) | 이름 | 수준 | 기본 가중치 | 하는 일 |
|---|---|---|---|
knapsack_ | 필수 | 1 | 고른 무게가 capacity를 넘은 만큼 벌점을 줍니다. |
resource_ | 필수 | 1 | 추가 자원의 한도를 넘은 만큼 벌점을 줍니다. |
mandatory_ | 필수 | 1 | 고르지 않은 필수 항목에 벌점을 줍니다. |
forbidden_ | 필수 | 1 | 고른 금지 항목에 벌점을 줍니다. |
selection_ | 필수 | 1 | 그룹에서 고른 개수가 범위를 벗어난 만큼 벌점을 줍니다. |
item_ | 필수 | 1 | 함께 골라야 할 항목 없이 고른 항목에 벌점을 줍니다. |
selected_ | 선호 보상 | 1 | 고른 가치의 합을 늘립니다. 비용을 음수로 계산해 가치가 클수록 점수가 올라갑니다. |
기존 해에서 시작하기
최신 버전이 필요합니다. pip install -U optimaru로 올려 주세요.
with_initial_solution(problem, solution)은 solution에서 탐색을 시작하는 problem의 복사본을 돌려줍니다. solution은 풀린 모델이나 그 JSON 딕셔너리입니다.
위의 최소 실행 예제에 이어서 실행합니다.
from optimaru.knapsack import with_initial_solution
warm = with_initial_solution(problem, problem.model_dump(mode="json"))
print(solve(warm, time_limit_seconds=1.0, random_seed=42))
print([item.id for item in warm.items if item.selected], warm.total_value) - 항목은 id로 맞춥니다.
selected: false는 고르지 않았다는 뜻이고 그대로 유지합니다. 해에서 빠진 항목은 이미 고른 무게를 감안해 그리디로 선택합니다.time_limit_seconds=0을 주면 바로 멈추므로 완전한 해는 넣은 그대로 돌아옵니다.step_count_limit = 0은 제한이 없다는 뜻이므로, 바로 멈추려면 시간 제한을 쓰세요.- 모르는 id, 중복, 불리언이 아닌 값은
ValueError를 냅니다.
예외와 제한
- 항목은 고르거나 고르지 않거나 둘 중 하나입니다. 일부만 고르거나 여러 번 고를 수 없습니다.