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

Added documentation discussing hangar core concepts #23

Merged
merged 4 commits into from
May 23, 2019

Conversation

rlizzo
Copy link
Member

@rlizzo rlizzo commented May 1, 2019

Discusses core data model, problems we try to solve, and the rationale
for solving them in the first place

ping @lantiga for discussion and review.

@rlizzo rlizzo closed this May 1, 2019
@rlizzo rlizzo deleted the doc-core-concepts branch May 1, 2019 23:25
@rlizzo rlizzo restored the doc-core-concepts branch May 1, 2019 23:25
@rlizzo rlizzo reopened this May 1, 2019
@rlizzo
Copy link
Member Author

rlizzo commented May 6, 2019

ping @hhsecond for review as well.

docs/concepts.rst Outdated Show resolved Hide resolved
data management utilities developed by the High Performance Computing community
over the past few decades.

In a sense, the backend of Hangar servers two functions:

Choose a reason for hiding this comment

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

"serves"

docs/concepts.rst Outdated Show resolved Hide resolved
@rlizzo rlizzo added this to the v0.1.0 Release milestone May 7, 2019
@rlizzo
Copy link
Member Author

rlizzo commented May 8, 2019

Thanks @elistevens, you're comments have been addressed!

ping @lantiga for general comments before I proofread and merge.

@rlizzo rlizzo added documentation WIP Don't merge; Work in Progress labels May 8, 2019
arrays of particular datatypes, shapes, and access patterns), we simultaneously
store different data pieces in the backend which is most suited to it. A great
deal of care has been taken to optimize parameters in the backend interface
which affecting performance and compression of data samples.

Choose a reason for hiding this comment

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

"which affecting" review wording?

property:

If you ``clone`` some hangar repository, Bookeeping says that "some number
of data piece exist" and they should retrieved from the server. However,

Choose a reason for hiding this comment

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

"pieces"?

Aka. You don't need data on disk to merge changes into it. It's an odd concept
which will be explained more in depth in the future.

.. note::

Choose a reason for hiding this comment

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

Move this up for full transparency.

Discusses core data model, problems we try to solve, and the rationale
for solving them in the first place
@rlizzo
Copy link
Member Author

rlizzo commented May 23, 2019

Thanks for the detailed feedback @elistevens. All comments have been resolved and I am going to merge this now

@rlizzo rlizzo removed the WIP Don't merge; Work in Progress label May 23, 2019
@rlizzo rlizzo merged commit 343264a into tensorwerk:master May 23, 2019
@rlizzo rlizzo deleted the doc-core-concepts branch June 13, 2019 06:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants