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

Generates docs for ndarrays #7688

Merged
merged 11 commits into from
Dec 12, 2019
Merged

Conversation

johnc1231
Copy link
Contributor

@johnc1231 johnc1231 commented Dec 9, 2019

This PR generates documentation for all current ndarray functionality. Wondering if to coincide with this we should also remove the _ from hl._nd. I mostly had it there so people wouldn't poke at undocumented functionality, but this seems to work ok now.

Resolves #7531

self.save(temp_file)
return np.load(temp_file)
# @typecheck_method(axis=nullable(oneof(int, sequenceof(int))))
# def sum(self, axis=None):
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not currently implemented, so I don't want it to show up on the NDArrayExpression class.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have not implemented NDArrayAgg IR Node

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah. Having a big block of commented out code is confusing. Could you save this in a branch and add it back when NDArrayAgg is implemented? Either that, or uncomment it, and have throw a "not implemented" error.


>>> hl._nd.zeros((5, 7), dtype=hl.tfloat32)


Parameters
----------
shape : `tuple` or `TupleExpression`
shape: `tuple` or :class:`.TupleExpression`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

space before :

@johnc1231 johnc1231 dismissed patrick-schultz’s stale review December 11, 2019 20:30

Thanks, made the changes.

@danking danking merged commit 8200b5b into hail-is:master Dec 12, 2019
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

Successfully merging this pull request may close these issues.

[hail][ndarray] NDArray Documentation
3 participants