yardstick-predict 0.4.0__tar.gz

yardstick_predict-0.4.0/.gitignore

@@ -0,0 +1,7 @@
+.venv/
+__pycache__/
+*.egg-info/
+.pytest_cache/
+.ruff_cache/
+dist/
+build/

yardstick_predict-0.4.0/CONTRIBUTING.md

@@ -0,0 +1,130 @@
+# Contributing to yardstick-predict
+
+Thanks for helping. This guide says how to report problems and how to send changes.
+
+## Set up and run the tests
+
+You need [uv](https://docs.astral.sh/uv/). It installs the right Python and every dependency.
+
+```bash
+git clone https://github.com/yusufcemaydin/yardstick-predict
+cd yardstick-predict
+uv sync
+uv run pytest
+```
+
+The tests never touch your own records, your Voyage key or your password store. They write their own small Claude Code and Codex records and use a stand-in for Voyage that runs on your computer.
+
+On a Mac without Homebrew's OpenMP, the tests need to find the copy that scikit-learn carries. Run them the way the automatic tests do:
+
+```bash
+export DYLD_FALLBACK_LIBRARY_PATH="$(uv run python -c 'import sklearn, os; print(os.path.join(os.path.dirname(sklearn.__file__), ".dylibs"))')"
+uv run pytest
+```
+
+New features and model types can live in a plugin, outside this repo. The front page's "Extend it" section shows how.
+
+Before you send a change, check the style too:
+
+```bash
+uv run ruff check src tests
+uv run ruff format src tests
+```
+
+[How it works](docs/how-it-works.md) explains the data, the model and the test. A change to the model must keep passing the test on real runs, not just the unit tests. Say in your pull request how it did.
+
+## Keep private data out
+
+The repository is public, so the tests include a privacy check, `tests/test_privacy.py`. It reads every file git tracks, except binary files and `uv.lock`, and fails when one holds:
+
+- an email address. GitHub's no-reply addresses, which reach no one, and the example domains `example.com`, `example.org` and `example.net` are fine.
+- a home folder with a real-looking user name, such as `/Users/<name>`, `/home/<name>` or `C:\Users\<name>`. The few made-up names the tests use are fine.
+- text shaped like a secret key: an Anthropic, OpenAI, Voyage, GitHub or AWS key, or a private key file.
+
+It names the file and line of each find, never the text itself, so its output is safe to share. It reads files only, not commit messages.
+
+Some words must stay private but can't be listed in a public file, such as the names of people, clients or other projects. Keep them in a file on your own computer, outside the repository, one a line. Case doesn't matter, and blank lines and lines that start with `#` are skipped. When the environment variable `YARDSTICK_PRIVATE_TERMS` names that file, the check fails on those words too:
+
+```bash
+YARDSTICK_PRIVATE_TERMS=~/private-terms.txt uv run pytest tests/test_privacy.py
+```
+
+To run it before every push, give git a pre-push hook: a script git runs before each push, which stops the push when the script fails. Save these two lines as `.git/hooks/pre-push`, then make the file runnable with `chmod +x .git/hooks/pre-push`:
+
+```sh
+#!/bin/sh
+YARDSTICK_PRIVATE_TERMS="$HOME/private-terms.txt" uv run pytest -q tests/test_privacy.py
+```
+
+## Predictors and models saved by past releases
+
+Each version keeps forecasting with the models the previous release saved, until a refresh trains them again. Anything older is asked to train again first. A version that meets a feature it doesn't know skips it, with a note.
+
+The tests check this against what past releases really saved. `tests/fixtures` holds a predictor that 0.3.0's own code made, and what it forecast. When a release changes how predictors or models are saved, add that release's fixture the same way, with tests that this version still reads it. [The fixtures' README](tests/fixtures/README.md) shows how the 0.3.0 one was made. Its model files are plain JSON and plain numbers, as the tool saves them, never pickle files.
+
+## Report a problem or suggest an idea
+
+Open an issue and pick a form:
+
+- **Bug report:** something broke or gave an error.
+- **Forecast was way off:** the predicted time or tokens were far from what really happened.
+- **Idea or request:** a new feature or a change.
+
+Search the open issues first. Someone may have reported it already.
+
+Security problems are different. Report them privately, as the [security policy](SECURITY.md) explains.
+
+## Send a change
+
+1. For anything bigger than a small fix, open an issue first. Agreeing on the idea first saves you wasted work.
+2. Fork the repo and make your change on a new branch.
+3. Keep each pull request to one change. Small pull requests get reviewed faster.
+4. Make sure the tests pass.
+5. Open a pull request. Say what it changes and why.
+
+A maintainer reads every pull request before it's merged.
+
+## Changes that need extra care
+
+These changes get a much closer review, and may be turned down:
+
+- install steps or build scripts,
+- the automatic checks in the `.github` folder,
+- new dependencies,
+- model files.
+
+Model files must use the safetensors format, which holds only numbers. Pull requests that add pickle files will be closed. These usually end in `.pkl`, `.pt` or `.pth`, and they can run code when someone opens them.
+
+Code that's minified, obfuscated or generated without its source will be closed too. Every line has to be readable.
+
+## AI-written changes
+
+You can use AI tools to write your change. You're still responsible for it. Read it, test it, and be ready to explain it.
+
+## Releasing
+
+Between releases, the version on the main branch ends in `.dev0`, such as `0.4.0.dev0`, which means work toward 0.4.0. To release it, a maintainer:
+
+1. Sets the version, such as `0.4.0`, in `pyproject.toml` and `src/yardstick_predict/__init__.py`, and runs `uv lock`.
+2. In `CHANGELOG.md`, renames `## [Unreleased]` to the version and the day, such as `## [0.4.0] - 2026-11-02`, and starts a new, empty `## [Unreleased]` above it.
+3. Merges that change into main once the tests pass.
+4. Tags the merged commit with the version and pushes the tag:
+
+   ```bash
+   git tag v0.4.0
+   git push origin v0.4.0
+   ```
+
+The tag starts the release workflow, `.github/workflows/release.yml`. It checks that the tag matches the version in both files, `v0.4.0` for `0.4.0`, and stops if not. Then it builds the package and publishes it on PyPI, the Python package index. Nothing else starts it: not pull requests, and not pushes to a branch.
+
+After the release, set the next version on main, such as `0.5.0.dev0`.
+
+Before the first release, set up PyPI once:
+
+1. Make an account on [PyPI](https://pypi.org) and turn on two-factor sign-in.
+2. Tell PyPI to trust this repository's release workflow, so it takes the upload with no password or token kept anywhere. PyPI calls this a trusted publisher. Before the project exists on PyPI, add it as a pending publisher, under Your account > Publishing, with the project name `yardstick-predict`, owner `yusufcemaydin`, repository `yardstick-predict`, workflow `release.yml` and environment `pypi`. The first release then creates the project.
+3. On GitHub, under the repository's Settings > Environments, create an environment named `pypi`. To approve each publish yourself, add yourself as a required reviewer. Under deployment branches and tags, allow only tags that match `v*`.
+
+## License
+
+By sending a change, you agree that it's released under the [Apache License 2.0](LICENSE), like the rest of the project.

yardstick_predict-0.4.0/LICENSE

@@ -0,0 +1,202 @@
+                                 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
+      (an example is provided in the Appendix below).
+
+      "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
+      (except as stated in this section) 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(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) 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 (and each
+      Contributor provides its Contributions) 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+