Registry / type-stubs / types-tensorflow

types-tensorflow

JSON →
library2.18.0.20260610pypypiunverified

types-tensorflow is a type stub package providing static type annotations for the TensorFlow library. Maintained as part of the `typeshed` project, it enables type checkers like MyPy and Pyright to analyze code using TensorFlow, improving code quality and developer tooling. This package aims to provide accurate annotations for specific TensorFlow minor versions (e.g., `~=2.18.0`). It follows a frequent release cadence, with minor and patch versions released regularly to keep pace with TensorFlow updates.

pip install types-tensorflow
INSTALL
IMPORT
SIG · TYPES-TENSORFLOW
T
types-tensorflow
type-stubspythonv2.18.0.20260610
Install
17.6s avg
Import
10401ms
Disk
92MB
Pass rate
5/ 10
Env Coverage5 / 10
glibc
3.93.13
musl
3.93.13
Install & Compatibility
Where this runs
tested against v2.18.0.20260610 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
glibc
py 3.10
4/8 runs
✓ 18.24s
py 3.11
4/8 runs
✓ 16.93s
py 3.12
4/8 runs
✓ 15.93s
py 3.13
4/8 runs
✓ 15.3s
py 3.9
4/8 runs
✓ 21.41s
92MB installed
● package 92MB
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

tensorflow-stubs
import tensorflow-stubs
import tensorflow

This quickstart demonstrates how to write type-hinted TensorFlow code that `types-tensorflow` can then be used to check with a static type checker like `mypy` or `pyright`. It shows basic tensor creation and manipulation with Python type annotations.

import tensorflow as tf def create_and_add_constants(val1: int, val2: int) -> tf.Tensor: """Creates two constant tensors from ints and adds them.""" tensor1 = tf.constant(val1, dtype=tf.int32) tensor2 = tf.constant(val2, dtype=tf.int32) return tf.add(tensor1, tensor2) def concatenate_tensors(tensors: list[tf.Tensor]) -> tf.Tensor: """Concatenates a list of tensors along axis 0.""" return tf.concat(tensors, axis=0) if __name__ == "__main__": # Example 1: Basic addition with type hints sum_result = create_and_add_constants(10, 20) print(f"Sum result (numpy value): {sum_result.numpy()}") # Example 2: Concatenation with explicit type hints tensor_a = tf.constant([1.0, 2.0], dtype=tf.float32) tensor_b = tf.constant([3.0, 4.0], dtype=tf.float32) combined_tensors = concatenate_tensors([tensor_a, tensor_b]) print(f"Concatenated tensors (numpy value): {combined_tensors.numpy()}") # To run type checking: # 1. Save this code as `tf_example.py`. # 2. Install a type checker (e.g., `pip install mypy`). # 3. Run `mypy tf_example.py` in your terminal. # Expected output: Success (no errors) if code is correctly typed.
Debug
Known issues
gotchaThe `types-tensorflow` package is marked as 'partial'. Type checkers, such as Pyright, often assume that if type stubs are present, they are authoritative for that module. This can lead to a lack of autocompletion or type information for parts of the TensorFlow API that are not yet covered by the stubs, rather than falling back to runtime introspection.
fix
Consult TensorFlow's official documentation for un-stubbed parts. Contribute to `typeshed` to help complete the stubs.
affects: All versions, as it's an inherent characteristic of partial stubs.
breakingThe `types-tensorflow` package aims to provide accurate annotations for specific TensorFlow minor versions (e.g., `tensorflow~=2.18.0`). Mismatches between the installed `types-tensorflow` version and your actual `tensorflow` runtime version can lead to incorrect or misleading type checking results, including false positives or missed errors.
fix
Always install `types-tensorflow` matching the minor version of your `tensorflow` installation, e.g., if you have `tensorflow==2.18.x`, install `types-tensorflow==2.18.x.YYYYMMDD`.
affects: All versions
gotchaTensorFlow's API relies heavily on dynamic method definitions, decorator magic, and internal re-exports (e.g., classes defined internally but exposed publicly via different paths). This complexity can make generating perfect type stubs challenging, potentially leading to situations where type checkers might produce false positives or fail to catch actual errors due to the discrepancies between the stub's static view and TensorFlow's runtime behavior.
fix
Be aware that some advanced or dynamically generated TensorFlow patterns might still require `type: ignore` comments or might not be perfectly covered by stubs. Consult TensorFlow documentation if types are unclear.
affects: All versions
breakingWhile `types-tensorflow` explicitly requires Python `>=3.10`, the underlying `tensorflow` library also has its own Python version compatibility requirements. For instance, TensorFlow 2.21 removed support for Python 3.9. Ensure that your Python environment satisfies the requirements of *both* `types-tensorflow` and the specific version of `tensorflow` you intend to use.
fix
Always verify Python compatibility with both the `types-tensorflow` package and your `tensorflow` installation. Upgrade your Python version if necessary.
affects: All versions
Upgrade
Version history
2.18.0.20260610latest on PyPI · released Jun 10, 2026
Audit
Dependencies
tensorflowrequiredProvides the runtime library for which these are type stubs. Specific minor versions are targeted (e.g., ~=2.18.0).
pythonrequiredRequires Python version >=3.10.
Agent activity
27 hits · last 30 days
node
24
OpenAI (training)
1
Resources
types-tensorflow — pip install types-tensorflow · libregistry