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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding docs #55

Merged
merged 3 commits into from
Nov 2, 2022
Merged

Adding docs #55

merged 3 commits into from
Nov 2, 2022

Conversation

mishig25
Copy link
Collaborator

@mishig25 mishig25 commented Nov 2, 2022

TLDR: add safetensors docs

I've added:

  1. Basic structure
  2. Example docstring

@Narsil please feel free to continue from here (directly push to this PR etc.)
When writing docs, please refer to this guide & transformers docs for reference

You can test the docs locally by:

pip install hf-doc-builder
pip install black watchdog
# replace the path with yours
doc-builder preview safetensors ~/Desktop/safetensors/docs/source/

Todos:

  • we should probably setup.py install extras as in extras["flax"] = (jax flax); extras["testing"] = extras["flax"]+extras["torch"]+...; so that doc-builder can just call pip install .[dev]. At the moment, I hacked them in Safetensors聽doc-builder#323
  • in the moon-ci-docs.huggingface.co preview, python setup.py develop is intalling main branch, not docs this branch. Hence,
    the docstring looks empty:

image

however, if you run locally with `doc-builder preview safetensors ...`, it renders as expected

image

I'm looking into this issue in the meantime

@Narsil please let me know of any questions 馃槉

@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint.

@Narsil Narsil marked this pull request as ready for review November 2, 2022 15:52
Copy link
Collaborator

@Narsil Narsil left a comment

Choose a reason for hiding this comment

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

LGTM

@Narsil Narsil merged commit a99b681 into main Nov 2, 2022
@Narsil Narsil deleted the docs branch November 2, 2022 15:52
@mishig25 mishig25 mentioned this pull request Nov 15, 2022
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.

None yet

3 participants