tensorflow.keras IDE auto-completion fails

Click to expand!

Issue Type

Bug

Source

binary

Tensorflow Version

tf 2.8 2.9

Custom Code

Yes

OS Platform and Distribution

win mac

Mobile device

No response

Python version

3.10

Bazel version

No response

GCC/Compiler version

No response

CUDA/cuDNN version

No response

GPU model and memory

No response

Current Behaviour?

A bug happened!
tensorflow.keras IDE auto-completion fails.
Using "from tensorflow." does not pop up keras, pycharm will report red but it works.
Also, tf 2.5 is normal.
I see there are other people who have had this problem

Standalone code to reproduce the issue

from tensorflow.keras import layers

Relevant log output

No response

@Yuri-Su

@Yuri-Su ,
Could you provide the error log which you are facing issue. It helps to debug the issue. Thank you!

So... there's no "error log" for code completion failures. As Yuri-Su mentioned, everyone is having the same issue.

Steps to reproduce:

from tensorflow.keras import Model

That's literally it. If you want to rule out other IDEs, configuration issues, etc etc, just go to https://www.tensorflow.org/tutorials/quickstart/advanced

Run the first cell:

A side question - does everyone just use Notepad++? This has been a persistent issue with VSCode and Pycharm since at least 2017. I'm baffled that it's not fixed, but I don't understand it well enough to fix it myself.

I would happily just buy a different IDE if there's one that supports code completion and doesn't break on every new TF release.

A side question - does everyone just use Notepad++? This has been a persistent issue with VSCode and Pycharm since at least 2017. I'm baffled that it's not fixed, but I don't understand it well enough to fix it myself.

I would happily just buy a different IDE if there's one that supports code completion and doesn't break on every new TF release.

As far as I know, this problem appeared from 2.6 and lasted until 2.9, if it is not solved, I am willing to use pytorch in the future.

@Yuri-Su

@Yuri-Su ,
I was able to import and execute the code in tensorflow version 2.8. Could you find the gist of it here. Thanks you!

Not a real solution at all, but I just want to mention that Keras V3 came out yesterday. If you can already use it, then you have no problem with this anymore.

This is so crazy.

PyCharm 2023.2.5 and VSCode 1.84.2 (pylance v2023.11.10) still issue with tensorflow 2.15.0.
I'm starting learning tensorflow, keras and all of that stuff and not being able to see autocompletion and being forced to memorising optimisers, layers, metrics, params etc. is frustrating 😢

@weidler

@weidler @OlegNovosad Are you using import keras or from tensorflow import keras?
import keras should always work for autocompletion.

@haifeng-jin

@haifeng-jin I'm using import tensorflow as tf and then tf.keras.<whatever>

@haifeng-jin

@haifeng-jin Also using import tensorflow as tf. Will switch to import keras though, since with Keras 3.0 that seems to be the recommended approach anyways.

@OlegNovosad

@OlegNovosad @weidler , Thanks for the reply! Unfortunately, I don't think we can do much about the tf.keras import path.

On the Keras side, we have implemented a new mechanism for API exporting, which works for both Keras 2 (since TF 2.13) & 3 for code completion. It creates real directories and files under the import path instead of just adding attributes. So it should work with all code completion tools in IDEs.

A note for new users:
Please import keras directly in order to use the code completion feature.

i made it autocompleting by changing import keras section line 397 in init.py tf 2.15 to:

# Lazy-load Keras v2/3.
import typing as _typing
if _typing.TYPE_CHECKING:
  from keras.api._v2 import keras
else:
  _tf_uses_legacy_keras = (
          _os.environ.get("TF_USE_LEGACY_KERAS", None) in ("true", "True", "1"))
  setattr(_current_module, "keras", _KerasLazyLoader(globals()))
  _module_dir = _module_util.get_parent_dir_for_name("keras._tf_keras.keras")
  _current_module.__path__ = [_module_dir] + _current_module.__path__
  if _tf_uses_legacy_keras:
    _module_dir = _module_util.get_parent_dir_for_name("tf_keras.api._v2.keras")
  else:
    _module_dir = _module_util.get_parent_dir_for_name("keras.api._v2.keras")
  _current_module.__path__ = [_module_dir] + _current_module.__path__

can someone please tell me if it's going to crash

This issue still exist in PyCharm 2024.2 with TensorFlow 2.16.1

Issue still persists on vscode .... 7 years down the line and no fix

interesting

This issue still exist in PyCharm 2024.2.1 with TensorFlow 2.17

I'm wondering why the issue is closed! please re-open it

This issue still exist in VScode 1.95.2 with Tensorflow 2.18.

@haifeng-jin

@haifeng-jin @Yuri-Su Please re-open the issue. problem still exists in TensorFlow 2.17 and 2.18

TensorFlow's team really really fail me for many times. Changing installation methods multiple times, annoying warnings after running code, and compatibility issues between "import" and IDE

@Letronxis Sadly worst thing is that long time issues like this are marked as closed and no one trying to open and follow them

Still unresolved. VSCode 1.99.2 Tensorflow 2.18.0.

Navigation Menu

Repository navigation

tensorflow.keras IDE auto-completion fails #56231

Issue Type

Source

Tensorflow Version

Custom Code

OS Platform and Distribution

Mobile device

Python version

Bazel version

GCC/Compiler version

CUDA/cuDNN version

GPU model and memory

Current Behaviour?

Standalone code to reproduce the issue

Relevant log output

73 remaining items

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

tensorflow.keras IDE auto-completion fails #56231

Description

Issue Type

Source

Tensorflow Version

Custom Code

OS Platform and Distribution

Mobile device

Python version

Bazel version

GCC/Compiler version

CUDA/cuDNN version

GPU model and memory

Current Behaviour?

Standalone code to reproduce the issue

Relevant log output

Activity

tilakrayal commented on May 24, 2022

Dadealos commented on May 24, 2022

Dadealos commented on May 24, 2022

Yuri-Su commented on May 25, 2022

tilakrayal commented on May 26, 2022

73 remaining items

michelkok commented on Nov 29, 2023

OlegNovosad commented on Dec 6, 2023

haifeng-jin commented on Dec 10, 2023

OlegNovosad commented on Dec 10, 2023

weidler commented on Dec 11, 2023

haifeng-jin commented on Dec 19, 2023

lllllllllaa commented on Dec 30, 2023

steveepreston commented on Aug 28, 2024

olurocks commented on Sep 19, 2024

steveepreston commented on Sep 19, 2024

yuanxiqd commented on Nov 8, 2024

steveepreston commented on Nov 8, 2024

Solitaron commented on Dec 1, 2024

steveepreston commented on Dec 7, 2024

Roobahist commented on Apr 14, 2025

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions