Size default thread pools from ORT_*_NUM_THREADS environment variables#29688
Open
OscarFree wants to merge 3 commits into
Open
Size default thread pools from ORT_*_NUM_THREADS environment variables#29688OscarFree wants to merge 3 commits into
OscarFree wants to merge 3 commits into
Conversation
|
Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run. |
Author
|
@microsoft-github-policy-service agree company="Wellocution, Inc."
…On Mon, Jul 13, 2026 at 12:58 PM microsoft-github-policy-service[bot] < ***@***.***> wrote:
*microsoft-github-policy-service[bot]* left a comment
(microsoft/onnxruntime#29688)
<#29688 (comment)>
@OscarFree <https://github.com/OscarFree> please read the following
Contributor License Agreement(CLA). If you agree with the CLA, please reply
with the following information.
@microsoft-github-policy-service agree [company="{your company}"]
Options:
- (default - no company specified) I have sole ownership of
intellectual property rights to my Submissions and I am not making
Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
- (when company given) I am making Submissions in the course of work
for my employer (or my employer has intellectual property rights in my
Submissions by contract or applicable law). I have permission from my
employer to make Submissions and enter into this Agreement on behalf of my
employer. By signing below, the defined term “You” includes me and my
employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement Contribution License Agreement
This Contribution License Agreement (*“Agreement”*) is agreed to by the
party signing below (*“You”*),
and conveys certain license rights to Microsoft Corporation and its
affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is
effective as of the latest signature
date below.
1. *Definitions*.
*“Code”* means the computer software code, whether in human-readable
or machine-executable form,
that is delivered by You to Microsoft under this Agreement.
*“Project”* means any of the projects owned or managed by Microsoft
and offered under a license
approved by the Open Source Initiative (www.opensource.org).
*“Submit”* is the act of uploading, submitting, transmitting, or
distributing code or other content to any
Project, including but not limited to communication on electronic
mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf
of, the Project for the purpose of
discussing and improving that Project, but excluding communication
that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”
*“Submission”* means the Code and any other copyrightable material
Submitted by You, including any
associated comments and documentation.
2. *Your Submission*. You must agree to the terms of this Agreement
before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now
or in the future (except as
described in Section 4 below), Submit to any Project.
3. *Originality of Work*. You represent that each of Your Submissions
is entirely Your original work.
Should You wish to Submit materials that are not Your original work,
You may Submit them separately
to the Project if You (a) retain all copyright and license information
that was in the materials as You
received them, (b) in the description accompanying Your Submission,
include the phrase “Submission
containing materials of a third party:” followed by the names of the
third party and any licenses or other
restrictions of which You are aware, and (c) follow any other
instructions in the Project’s written
guidelines concerning Submissions.
4. *Your Employer*. References to “employer” in this Agreement include
Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a
contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your
employer has intellectual
property rights in Your Submission by contract or applicable law, You
must secure permission from Your
employer to make the Submission before signing this Agreement. In that
case, the term “You” in this
Agreement will refer to You and the employer collectively. If You
change employers in the future and
desire to Submit additional Submissions for the new employer, then You
agree to sign a new Agreement
and secure permission from the new employer before Submitting those
Submissions.
5. *Licenses*.
- *Copyright License*. You grant Microsoft, and those who receive the
Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive,
royalty-free, irrevocable license in the
Submission to reproduce, prepare derivative works of, publicly
display, publicly perform, and distribute
the Submission and such derivative works, and to sublicense any or all
of the foregoing rights to third
parties.
- *Patent License*. You grant Microsoft, and those who receive the
Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive,
royalty-free, irrevocable license under
Your patent claims that are necessarily infringed by the Submission or
the combination of the
Submission with the Project to which it was Submitted to make, have
made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the
Project.
- *Other Rights Reserved*. Each party reserves all rights not
expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without
limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.
6. *Representations and Warranties*. You represent that You are
legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your
original work (except as You may
have disclosed under Section 3). You represent that You have secured
permission from Your employer to
make the Submission in cases where Your Submission is made in the
course of Your work for Your
employer or Your employer has intellectual property rights in Your
Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You
represent and warrant that You
have the necessary authority to bind the listed employer to the
obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless
You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE
WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED
UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO,
ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
7. *Notice to Microsoft*. You agree to notify Microsoft in writing of
any facts or circumstances of which
You later become aware that would make Your representations in this
Agreement inaccurate in any
respect.
8. *Information about Submissions*. You agree that contributions to
Projects and information about
contributions may be maintained indefinitely and disclosed publicly,
including Your name and other
information that You submit with Your Submission.
9. *Governing Law/Jurisdiction*. This Agreement is governed by the
laws of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal
courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in
which case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County,
Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.
10. *Entire Agreement/Assignment*. This Agreement is the entire
agreement between the parties, and
supersedes any and all prior agreements, understandings or
communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may
be assigned by Microsoft.
—
Reply to this email directly, view it on GitHub
<#29688?email_source=notifications&email_token=ASK44OYN23Z4K3QOW7MXN2T5EUIKNA5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTIOJWGA2DQMBSGY42M4TFMFZW63VHNVSW45DJN5XKKZLWMVXHJLDGN5XXIZLSL5RWY2LDNM#issuecomment-4960480269>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ASK44OYLBVTLPST5JP24X635EUIKNAVCNFSNUABFKJSXA33TNF2G64TZHMYTKNRZGM4TMNZSHNEXG43VMU5TIOBXGU4DEMBZHE22C5QC>
.
Triage notifications, keep track of coding agent tasks and review pull
requests on the go with GitHub Mobile for iOS
<https://github.com/notifications/mobile/ios/ASK44O6UWA7655ZIEL7QXDT5EUIKNA5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTIOJWGA2DQMBSGY42M4TFMFZW63VHNVSW45DJN5XKKZLWMVXHJKTGN5XXIZLSL5UW64Y>
and Android
<https://github.com/notifications/mobile/android/ASK44O7SM5E3RWWIDVBOX3T5EUIKNA5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTIOJWGA2DQMBSGY42M4TFMFZW63VHNVSW45DJN5XKKZLWMVXHJLTGN5XXIZLSL5QW4ZDSN5UWI>.
Download it today!
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
skottmckay
reviewed
Jul 14, 2026
skottmckay
previously approved these changes
Jul 15, 2026
Author
|
@skottmckay the ci failure is unrelated, could you re-run please? |
Contributor
|
It's related. The code change is bumping the minimal Android build binary size past the current max. It's fine to add 10K to that in .github\workflows\android.yml echo "Binary size threshold in bytes: 1440768"
BINARY_SIZE_THRESHOLD_ARGS="--threshold_size_in_bytes 1440768"You'll also need to sync with the latest main to pickup some workflow config changes. Without that a number of CIs will fail. |
When thread_pool_size is not set programmatically (<= 0), consult ORT_INTRA_OP_NUM_THREADS / ORT_INTER_OP_NUM_THREADS before falling back to the machine-sized default. Parsing is strict (a negative or non-integer value fails loudly); an explicit 0 opts back into the machine-sized default. Explicit session/global threading options are unaffected. Motivation: ONNX Runtime's default intra-op pool sizes to the host's physical cores, which oversubscribes CPU-limited containers where the cgroup CPU reservation is invisible to core detection. These variables let a container platform bound ORT's pools without reaching every InferenceSession call site. Addresses microsoft#29510.
thread_pool_size's contract is 0 = default, 1 = no pool, n = n threads; negatives are not a valid input. Tightening the guard to == 0 means the env-var path only affects the default case and never overwrites a non-zero (or negative) caller-provided value. Anything < 0 falls through to CreateThreadPoolHelper's existing default handling, unchanged.
The env-var thread-pool sizing added to core (ParseEnvironmentVariable in thread_utils.cc) grows the minimal Android build ~just past the current 1440768-byte ceiling. Bump the threshold by 10K per maintainer guidance.
OscarFree
force-pushed
the
env-var-ort-thread-count
branch
from
July 18, 2026 13:22
a95edf7 to
75a1840
Compare
Author
|
ah, thanks for the tip! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
When a thread pool's size is not set programmatically (
thread_pool_size <= 0), size it fromORT_INTRA_OP_NUM_THREADS/ORT_INTER_OP_NUM_THREADSbefore falling back to the machine-sized default. ExplicitSessionOptions/ global threading options are completely unaffected.ORT_ENFORCE).= 0escape hatch — an explicit0opts back into the machine-sized default (useful when a platform sets these but you want host-sized pools).Implements #29510.
Why
ORT's default intra-op pool sizes to the host's physical cores (
GetNumPhysicalCpuCores()). In CPU-limited containers (Kubernetes, Modal, Cloud Run, …) the cgroup CPU reservation is invisible to core detection, so a container reserved N cores on a much larger host gets an N′-sized pool sized to the host — oversubscribing the reservation and degrading tail latency badly under concurrency, with no environment-level way to bound ORT today. The only current fix is passingSessionOptionsat everyInferenceSessioncall site, which is unreachable when sessions are created inside third-party libraries.Scope note (re: @skottmckay's feedback on #29510)
The original proposal also honored
OMP_NUM_THREADSas an intra-op fallback. Per the discussion on #29510, this PR is deliberately scoped to ORT-specific variables only — that keeps the semantics under ORT's control and avoids the "why notOPENBLAS_NUM_THREADS/MKL_NUM_THREADSnext" ambiguity. AnOMP_NUM_THREADSfallback can be a follow-up if there's demand.Tests
Adds 4
ThreadPoolTestcases (all pin the env vars viaScopedEnvironmentVariablesso ambient values can't leak): intra + inter sizing from the ORT vars, explicit size wins over env, the0escape hatch, and invalid-value-throws. Comparisons are made against a reference pool of the intended explicit size becauseDegreeOfParallelismscales by a granularity factor on hybrid CPUs.I was not able to build/run the ORT test suite locally on this machine, so I'm relying on CI to validate the build +
ThreadPoolTest.