Skip to content
This repository has been archived by the owner on Jul 17, 2024. It is now read-only.

chore: Change class and decorators locations to match new layout #44

Merged
merged 2 commits into from
May 3, 2024
Merged

chore: Change class and decorators locations to match new layout #44

merged 2 commits into from
May 3, 2024

Conversation

Christopher-Chianelli
Copy link
Collaborator

  • In general, ai.timefold.solver.core.api.x and its subpackages -> timefold.solver.x.

  • Exception for ai.timefold.solver.core.api.solver, which it and its subpackages -> timefold.solver.

  • ai.timefold.solver.core.x and its subpackages -> timefold.solver.x (test and config).

  • Use dynamic all when not TYPE_CHECKING for score and domain, since they have some classes that require the JVM to be started When TYPE_CHECKING, there are stub classes that the TYPE_CHECKER will see.

  • Remove @incremental_score_calculator decorator, since it been replaced by IncrementalScoreCalculator ABC.

  • Create an empty Constraint stub so users can reference it in their type signatures without importing something from Java.

- In general, ai.timefold.solver.core.api.x and its subpackages ->
  timefold.solver.x.

- Exception for ai.timefold.solver.core.api.solver, which it and
  its subpackages -> timefold.solver.

- ai.timefold.solver.core.x and its subpackages -> timefold.solver.x
  (test and config).

- Use dynamic __all__ when not TYPE_CHECKING for score and domain,
  since they have some classes that require the JVM to be started
  When TYPE_CHECKING, there are stub classes that the TYPE_CHECKER
  will see.

- Remove `@incremental_score_calculator` decorator, since it been replaced
  by `IncrementalScoreCalculator` ABC.

- Create an empty Constraint stub so users can reference it in their type
  signatures without importing something from Java.
@Christopher-Chianelli
Copy link
Collaborator Author

Christopher-Chianelli commented May 2, 2024

Where should nearby_distance_meter go (which is inside an impl.heuristic.selector)? I currently have it with the domain classes; probably should be moved to timefold.solver.heuristic?

@Christopher-Chianelli
Copy link
Collaborator Author

Copy link
Contributor

@triceo triceo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, but there are some loose ends to tie up in follow-up PRs.

@Christopher-Chianelli Christopher-Chianelli merged commit 35932ad into TimefoldAI:main May 3, 2024
3 checks passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants