This repository was archived by the owner on Nov 1, 2024. It is now read-only.
Doc update #385
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| name: Deploy Doc | ||
| on: | ||
| # Allows you to run this workflow manually from the Actions tab | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Setup Python environment | ||
| uses: actions/setup-python@v2 | ||
| with: | ||
| python-version: 3.7 | ||
|
|
||
| - name: Check out source repository | ||
| uses: actions/checkout@v2 | ||
| with: | ||
| ref: "release/0.1.0" | ||
| submodules: recursive | ||
|
|
||
| - name: Install TorchArrow | ||
| run: | | ||
| pip install --pre torcharrow -f https://download.pytorch.org/whl/nightly/cpu/torch_nightly.html | ||
|
|
||
| - name: Build the docs | ||
| run: | | ||
| cd ./docs | ||
| pip install -r requirements.txt --user | ||
| make html | ||
| cd .. | ||
|
|
||
| - name: Deploy Docs on Push | ||
| uses: JamesIves/github-pages-deploy-action@v4.2.5 | ||
| with: | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
| branch: gh-pages # The branch the action should deploy to. | ||
| folder: docs/build/html # The folder the action should deploy. | ||
| target-folder: 0.1.0 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -77,18 +77,3 @@ jobs: | |
| - name : Install TorchArrow | ||
| run: | | ||
| CCACHE_DIR=$GITHUB_WORKSPACE/.ccache python setup.py install --user | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,8 +3,8 @@ | |
| torcharrow.Column | ||
| ========================== | ||
|
|
||
| A :class:`torcharrow.Column` is a 1-dimension torch.Tensor like data structure containing | ||
| elements of a single data type. It also supports non-numeric types such as string, | ||
| list, struct. | ||
|
|
||
| Data types | ||
|
|
@@ -40,6 +40,7 @@ Column class reference | |
| .. autosummary:: | ||
| :toctree: generated | ||
| :nosignatures: | ||
| :template: class.rst | ||
|
There was a problem hiding this comment. You may want to check if the output page looks as you expect and edit the docstrings or template.
Contributor
Author
There was a problem hiding this comment. yep it looks the same to me with or without haha. |
||
|
|
||
| Column.head | ||
| Column.tail | ||
|
|
@@ -63,7 +64,7 @@ Column class reference | |
| Column.to_arrow | ||
| Column.to_tensor | ||
| Column.to_pylist | ||
| Column.to_pandas | ||
|
Contributor
There was a problem hiding this comment. separate to this PR -- looks like the current Pandas conversion is not efficient (e.g. it gets the element into Python format, then convert into Pandas format...): torcharrow/torcharrow/icolumn.py Lines 1104 to 1106 in f557525 Maybe we should use something like |
||
|
|
||
|
|
||
| NumericalColumn class reference | ||
|
|
@@ -73,6 +74,7 @@ NumericalColumn class reference | |
| .. autosummary:: | ||
| :toctree: generated | ||
| :nosignatures: | ||
| :template: class.rst | ||
|
|
||
| NumericalColumn.abs | ||
| NumericalColumn.ceil | ||
|
|
@@ -96,42 +98,44 @@ StringColumn class reference | |
| .. autosummary:: | ||
| :toctree: generated | ||
| :nosignatures: | ||
| :template: class.rst | ||
|
|
||
| istring_column.StringMethods.length | ||
|
Contributor
There was a problem hiding this comment. as a follow-up, maybe we should rename (btw, how does Pandas render doc or implement
Contributor
Author
There was a problem hiding this comment. is this how pandas implemented it? https://github.com/pandas-dev/pandas/blob/main/pandas/core/series.py#L5851 |
||
| istring_column.StringMethods.slice | ||
| istring_column.StringMethods.split | ||
| istring_column.StringMethods.strip | ||
|
|
||
| istring_column.StringMethods.isalpha | ||
| istring_column.StringMethods.isnumeric | ||
| istring_column.StringMethods.isalnum | ||
| istring_column.StringMethods.isdigit | ||
| istring_column.StringMethods.isdecimal | ||
| istring_column.StringMethods.isspace | ||
| istring_column.StringMethods.islower | ||
| istring_column.StringMethods.isupper | ||
| istring_column.StringMethods.istitle | ||
|
|
||
| istring_column.StringMethods.lower | ||
| istring_column.StringMethods.upper | ||
|
|
||
| istring_column.StringMethods.startswith | ||
| istring_column.StringMethods.endswith | ||
| istring_column.StringMethods.count | ||
| istring_column.StringMethods.find | ||
| istring_column.StringMethods.replace | ||
| istring_column.StringMethods.match | ||
| istring_column.StringMethods.contains | ||
| istring_column.StringMethods.findall | ||
|
|
||
| ListColumn class reference | ||
| ----------------------------------- | ||
| .. class:: ListColumn() | ||
|
|
||
| .. autosummary:: | ||
| :toctree: generated | ||
| :nosignatures: | ||
| :template: class.rst | ||
|
|
||
| ilist_column.ListMethods.length | ||
| ilist_column.ListMethods.slice | ||
| ilist_column.ListMethods.vmap | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does the schedule make sure we can get the nightly build on the same day? ^_^
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think there's no guarantee --- depending on which one runs first. I'm actually thinking to change this one to manual run only, since it writes to the "release" folder and shouldn't be needed to run nightly. But in this case, we'll need to be careful which version of torcharrow build it installs. Here I'm using the nightly build because that's the one available, but ideally I should use a RC build, which is currently not uploaded anywhere.
On the other hand, we can probably leave a build and deploy doc section to one of the nightly builds, and make sure it uploads the doc to the "main" folder (like torchdata).
But yeah this still needs some tweaks.