@tuned-tensor/cli 0.4.24 → 0.5.0

package/LICENSE

@@ -1,21 +1,161 @@
-MIT License
-
-Copyright (c) 2026 Weijian Zhang
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the
+copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other
+entities that control, are controlled by, or are under common control with
+that entity. For the purposes of this definition, "control" means (i) the
+power, direct or indirect, to cause the direction or management of such
+entity, whether by contract or otherwise, or (ii) ownership of fifty percent
+(50%) or more of the outstanding shares, or (iii) beneficial ownership of
+such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation source, and
+configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object
+code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form,
+made available under the License, as indicated by a copyright notice that is
+included in or attached to the work.
+
+"Derivative Works" shall mean any work, whether in Source or Object form,
+that is based on (or derived from) the Work and for which the editorial
+revisions, annotations, elaborations, or other modifications represent, as a
+whole, an original work of authorship. For the purposes of this License,
+Derivative Works shall not include works that remain separable from, or
+merely link (or bind by name) to the interfaces of, the Work and Derivative
+Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original
+version of the Work and any modifications or additions to that Work or
+Derivative Works thereof, that is intentionally submitted to Licensor for
+inclusion in the Work by the copyright owner or by an individual or Legal
+Entity authorized to submit on behalf of the copyright owner. For the purposes
+of this definition, "submitted" means any form of electronic, verbal, or
+written communication sent to the Licensor or its representatives, 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 Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise designated
+in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on
+behalf of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable copyright license to
+reproduce, prepare Derivative Works of, publicly display, publicly perform,
+sublicense, and distribute the Work and such Derivative Works in Source or
+Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable patent license to make,
+have made, use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable by such
+Contributor that are necessarily infringed by their Contribution alone or by
+combination of their Contribution with the Work to which such Contribution
+was submitted. If You institute patent litigation against any entity
+(including a cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct or
+contributory patent infringement, then any patent licenses granted to You
+under this License for that Work shall terminate as of the date such
+litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or
+Derivative Works thereof in any medium, with or without modifications, and in
+Source or Object form, provided that You meet the following conditions:
+
+(a) You must give any other recipients of the Work or Derivative Works a copy
+of this License; and
+
+(b) You must cause any modified files to carry prominent notices stating that
+You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works that You
+distribute, all copyright, patent, trademark, and attribution notices from the
+Source form of the Work, excluding those notices that do not pertain to any
+part of the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its distribution,
+then any Derivative Works that You distribute must include a readable copy of
+the attribution notices contained within such NOTICE file, excluding those
+notices that do not pertain to any part of the Derivative Works, in at least
+one of the following places: within a NOTICE text file distributed as part of
+the Derivative Works; within the Source form or documentation, if provided
+along with the Derivative Works; or, within a display generated by the
+Derivative Works, if and wherever such third-party notices normally appear.
+The contents of the NOTICE file are for informational purposes only and do
+not modify the License. You may add Your own attribution notices within
+Derivative Works that You distribute, alongside or as an addendum to the
+NOTICE text from the Work, provided that such additional attribution notices
+cannot be construed as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a
+whole, provided Your use, reproduction, and distribution of the Work otherwise
+complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any
+Contribution intentionally submitted for inclusion in the Work by You to the
+Licensor shall be under the terms and conditions of this License, without any
+additional terms or conditions. Notwithstanding the above, nothing herein
+shall supersede or modify the terms of any separate license agreement you may
+have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names,
+trademarks, service marks, or product names of the Licensor, except as
+required for reasonable and customary use in describing the origin of the Work
+and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in
+writing, Licensor provides the Work on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied, including, without
+limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT,
+MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely
+responsible for determining the appropriateness of using or redistributing
+the Work and assume any risks associated with Your exercise of permissions
+under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in
+tort (including negligence), contract, or otherwise, unless required by
+applicable law (such as deliberate and grossly negligent acts) or agreed to in
+writing, shall any Contributor be liable to You for damages, including any
+direct, indirect, special, incidental, or consequential damages of any
+character arising as a result of this License or out of the use or inability
+to use the Work, including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all other
+commercial damages or losses, even if such Contributor has been advised of
+the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work
+or Derivative Works thereof, You may choose to offer, and charge a fee for,
+acceptance of support, warranty, indemnity, or other liability obligations
+and/or rights consistent with this License. However, in accepting such
+obligations, You may act only on Your own behalf and on Your sole
+responsibility, not on behalf of any other Contributor, and only if You agree
+to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

package/README.md

@@ -1,15 +1,15 @@
 # tt - Tuned Tensor CLI
 
-`tt` is the command-line client for the optional managed
-[Tuned Tensor](https://www.tunedtensor.com) service. Use it to define behaviour
-specs, launch managed fine-tuning runs, inspect paired baseline-vs-tuned
-reports, and download or serve trained models. For local CUDA or DGX Spark
-training without a Tuned Tensor account, use `tt-local` from
-`@tuned-tensor/local`.
+`tt` is one terminal for the complete Tuned Tensor workflow:
 
-The main CLI documentation lives at
-[tunedtensor.com/docs/cli](https://tunedtensor.com/docs/cli). This README is a
-short install and development reference.
+- hosted specs, datasets, labeling, training, reports, and model downloads;
+- local CUDA fine-tuning, held-out evaluation, artifact verification, model
+  activation, and OpenAI-compatible serving.
+
+Existing commands such as `tt runs`, `tt models`, and `tt push` remain hosted
+commands. The local workflow lives under `tt local`, so scripts keep their
+current meaning while people can switch between both targets in one
+interactive shell.
 
 ## Install
 
@@ -18,6 +18,11 @@ npm install -g @tuned-tensor/cli
 tt --version
 ```
 
+Node.js 22 or newer is required. Hosted commands need no local ML runtime.
+Local training additionally needs
+[`uv`](https://docs.astral.sh/uv/) and a supported NVIDIA CUDA host; the locked
+Python runner ships with the npm dependency and is prepared on first use.
+
 Run from source:
 
 ```bash
@@ -28,7 +33,28 @@ npm run build
 npm link
 ```
 
-## Quick Start
+## Terminal shell
+
+Run `tt` in an interactive terminal to open the Tuned Tensor shell:
+
+```text
+tt cloud support-agent › auth status
+tt cloud support-agent › /mode local
+tt local support-agent › doctor
+tt local support-agent › run --dry-run
+```
+
+Commands are routed to the mode shown in the prompt. Prefix a single command
+with `cloud` or `local` to override the mode without switching it. Useful
+session commands include `/help`, `/status`, `/context`, `/mode`, `/cd`,
+`/clear`, and `/exit`. The shell keeps normal terminal scrollback and command
+history only for the current process.
+
+Explicit commands remain non-interactive, including in CI. `tt --help` shows
+the complete command surface, `tt status` inspects both targets without a
+network or GPU probe, and `tt shell` opens the shell explicitly.
+
+## Hosted quick start
 
 ```bash
 tt auth login
@@ -43,6 +69,70 @@ tt runs watch <run-id>
 tt runs report <run-id>
 ```
 
+The hosted service remains optional. Before a paid run, inspect the estimate:
+
+```bash
+tt balance
+tt runs estimate <spec-id>
+tt runs start <spec-id>
+```
+
+## Local quick start
+
+Create a local project on an NVIDIA host:
+
+```bash
+mkdir support-adapter && cd support-adapter
+tt local init \
+  --name "Support Adapter" \
+  --model Qwen/Qwen3.5-2B \
+  --profile spark
+```
+
+Edit the generated `tunedtensor.json`, replacing both placeholder examples,
+then preflight and run:
+
+```bash
+tt local doctor tunedtensor.json
+tt local validate tunedtensor.json
+tt local models prefetch tunedtensor.json
+tt local run tunedtensor.json
+```
+
+Inspect, verify, and serve a completed adapter:
+
+```bash
+tt local runs report <run-id>
+tt local models verify local-<run-id>
+tt local models serve local-<run-id> --config local-runner.json
+```
+
+Local currently certifies text SFT with `Qwen/Qwen3.5-2B`, LoRA/PEFT, and CUDA.
+Evaluation and serving may use CPU. Training artifacts, datasets, and model
+weights remain on the execution host.
+
+Activation is optional and requires the run to pass a configured
+`generalRegression` gate. Once activated, use
+`tt local serve active --config local-runner.json`.
+
+### One project file, target-specific payloads
+
+Both workflows use `tunedtensor.json`, but their supported fields are not
+identical. `tt` keeps the source file intact and projects only fields accepted
+by the selected target:
+
+- hosted pushes omit local-only `hyperparameters` and `dataset_prebuilt`;
+- local run, validation, prefetch, and explicit `--spec` serving commands omit
+  cloud-only executable `eval_cases`;
+- the default hosted scaffold contains two distinct examples and is valid as
+  a starting point for local held-out evaluation.
+
+Target validation is still authoritative. In particular, choosing a hosted
+base model does not make that model supported by the local CUDA runner.
+`tt local serve base` does not automatically inject the adjacent project spec.
+Pass `--spec tunedtensor.json` when the server should enforce its instructions;
+that explicit spec is projected for the local runtime.
+
 To continue training from a completed fine-tuned model artifact:
 
 ```bash
@@ -112,4 +202,4 @@ npm test
 
 ## License
 
-MIT
+Apache-2.0