Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documented pathfinding configuration defaults: #4409

Merged
merged 3 commits into from
Feb 8, 2023

Conversation

ximinez
Copy link
Collaborator

@ximinez ximinez commented Feb 3, 2023

High Level Overview of Change

417cfc2 changed the default Path Finding configuration values, but missed updating the values documented in rippled-example.cfg.

This change updates those defaults, and adds recommended values for node which want to support "advanced" pathfinding, which is effectively the old default behavior.

Type of Change

  • [X ] Documentation Updates

* Add recommended values for node which want to support "advanced"
  pathfinding, which is effectively the old default behavior.
@ximinez ximinez added the Documentation README changes, code comments, etc. label Feb 3, 2023
@@ -758,7 +758,9 @@
# When searching for paths, the default search aggressiveness. This can take
# exponentially more resources as the size is increased.
#
# The default is: 7
# The recommended value to support advanced pathfinding is: 7
Copy link
Contributor

Choose a reason for hiding this comment

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

why though?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm not aware of anything special about 7 other than the fact that it worked well for many years, and is a balance between being unable to find an acceptable path vs. resource consumption. @ximinez @JoelKatz any thoughts to share here?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yep. That's pretty much it. I kind of intentionally left it vague because anybody who doesn't specifically want pathfinding will be just fine with the defaults, and anyone who does probably just wants a reasonable recommendation. If they are more advanced than that, then any "tl;dr" summary in the config file is going to be insufficient - those users should dig into the code or other documentation.

@@ -767,12 +769,19 @@
# If you do not need pathfinding, you can set path_search_max to zero to
# disable it and avoid some expensive bookkeeping.
#
# The default for 'path_search_fast' is 2. The default for 'path_search_max' is 10.
# To support advanced pathfinding the recommended value for
# 'path_search_fast' is 2, and for 'path_search_max' is 10.
Copy link
Contributor

Choose a reason for hiding this comment

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

why?

# aggressiveness to use. The default is 7.
# aggressiveness to use.
#
# The recommended value to support advanced pathfinding is: 7.
Copy link
Contributor

Choose a reason for hiding this comment

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

why?

Copy link
Contributor

@ledhed2222 ledhed2222 left a comment

Choose a reason for hiding this comment

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

approved for speed - but it would be nice to explain why the specified values are recommended.

@intelliot intelliot added Trivial Passed Passed code review & PR owner thinks it's ready to merge. Perf sign-off may still be required. labels Feb 6, 2023
* upstream/develop:
  Update dependency: grpc (XRPLF#4407)
  Introduce min/max observers for Number
  Optimize uint128_t division by 10 within Number.cpp
  Replace Number division algorithm
  Include rounding mode in XRPAmount to STAmount conversion.
  Remove undefined behavior * Taking the negative of a signed negative is UB, but   taking the negative of an unsigned is not.
  Silence warnings
  Introduce rounding modes for Number:
  Use Number for IOUAmount and STAmount arithmetic
  Add tests
  Add implicit conversion from STAmount to Number
  Add clip
  Add conversions between Number, XRPAmount and int64_t
  AMM Add Number class and associated algorithms
@intelliot intelliot merged commit 8f51493 into XRPLF:develop Feb 8, 2023
@ximinez ximinez deleted the default-pf-cfg branch February 8, 2023 21:50
ximinez added a commit to ximinez/rippled that referenced this pull request Feb 9, 2023
* upstream/develop:
  Update documented pathfinding configuration defaults: (XRPLF#4409)
ximinez added a commit to ximinez/rippled that referenced this pull request Feb 9, 2023
* upstream/develop:
  Update documented pathfinding configuration defaults: (XRPLF#4409)
ximinez added a commit to ximinez/rippled that referenced this pull request Feb 9, 2023
* upstream/develop:
  Update documented pathfinding configuration defaults: (XRPLF#4409)
ximinez added a commit to ximinez/rippled that referenced this pull request Feb 9, 2023
* upstream/develop:
  Update documented pathfinding configuration defaults: (XRPLF#4409)
ximinez added a commit to ximinez/rippled that referenced this pull request Feb 9, 2023
* upstream/develop:
  Update documented pathfinding configuration defaults: (XRPLF#4409)
ximinez added a commit to ximinez/rippled that referenced this pull request Feb 9, 2023
…ctionality

* upstream/develop:
  Update documented pathfinding configuration defaults: (XRPLF#4409)
  Update dependency: grpc (XRPLF#4407)
  Introduce min/max observers for Number
  Optimize uint128_t division by 10 within Number.cpp
  Replace Number division algorithm
  Include rounding mode in XRPAmount to STAmount conversion.
  Remove undefined behavior * Taking the negative of a signed negative is UB, but   taking the negative of an unsigned is not.
  Silence warnings
  Introduce rounding modes for Number:
  Use Number for IOUAmount and STAmount arithmetic
  Add tests
  Add implicit conversion from STAmount to Number
  Add clip
  Add conversions between Number, XRPAmount and int64_t
  AMM Add Number class and associated algorithms
  Revise CONTRIBUTING (XRPLF#4382)
ximinez added a commit to ximinez/rippled that referenced this pull request Feb 9, 2023
…tpage

* upstream/develop: (37 commits)
  Update documented pathfinding configuration defaults: (XRPLF#4409)
  Update dependency: grpc (XRPLF#4407)
  Introduce min/max observers for Number
  Optimize uint128_t division by 10 within Number.cpp
  Replace Number division algorithm
  Include rounding mode in XRPAmount to STAmount conversion.
  Remove undefined behavior * Taking the negative of a signed negative is UB, but   taking the negative of an unsigned is not.
  Silence warnings
  Introduce rounding modes for Number:
  Use Number for IOUAmount and STAmount arithmetic
  Add tests
  Add implicit conversion from STAmount to Number
  Add clip
  Add conversions between Number, XRPAmount and int64_t
  AMM Add Number class and associated algorithms
  Revise CONTRIBUTING (XRPLF#4382)
  `XRPFees`: Fee setting and handling improvements (XRPLF#4247)
  Update BUILD.md (XRPLF#4383)
  Make NodeToShardRPC a manual test (XRPLF#4379)
  Update build instructions (XRPLF#4376)
  ...
dangell7 pushed a commit to Transia-RnD/rippled that referenced this pull request Mar 5, 2023
* Add recommended values for node which want to support "advanced"
  pathfinding, which is effectively the old default behavior.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation README changes, code comments, etc. Passed Passed code review & PR owner thinks it's ready to merge. Perf sign-off may still be required. Trivial
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants