Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Problem in the documentation #5622

Closed
amirj opened this issue Nov 15, 2016 · 2 comments
Closed

Problem in the documentation #5622

amirj opened this issue Nov 15, 2016 · 2 comments
Assignees

Comments

@amirj
Copy link

amirj commented Nov 15, 2016

It seems that the documentation has a problem. For example, the most useful functions such as fit or evaluate in the documentation of tf.contrib.learn is as follows:

tf.contrib.learn.Estimator.fit(x=None, y=None, input_fn=None, steps=None, batch_size=None, monitors=None, max_steps=None)

See Trainable.

Raises:

ValueError: If x or y are not None while input_fn is not None.
ValueError: If both steps and max_steps are not None.

Trainable does not linked or described in the generated documentation. It's really annoying issue for beginners.

@girving
Copy link
Contributor

girving commented Nov 16, 2016

Assigning to @martinwicke for further triage. There are quite a few of these missing links, so some sort of automated or semi-scripted method may be in order.

@martinwicke
Copy link
Member

I'm publishing the Trainable/Evaluable docs. Sorry about that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants