This is an automated email from the ASF dual-hosted git repository.
kunalkapoor pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/carbondata.git
The following commit(s) were added to refs/heads/master by this push:
new 4081e6a [CARBONDATA-3791] update pycarbon document
4081e6a is described below
commit 4081e6a69874487e851e1084a15b9d1253ea9ae5
Author: ajantha-bhat <[email protected]>
AuthorDate: Wed May 13 22:15:45 2020 +0530
[CARBONDATA-3791] update pycarbon document
Why is this PR needed?
setup.cfg lies outside the folder. so need to update the document on the
same.
What changes were proposed in this PR?
setup.cfg lies outside the folder. so need to update the document on the
same.
some other minor fix.
This closes #3767
---
python/README.md | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/python/README.md b/python/README.md
index ff4d2e0..b16ad00 100644
--- a/python/README.md
+++ b/python/README.md
@@ -6,7 +6,7 @@ PyCarbon provides python API for integrating CarbonData with AI
framework like
$ git clone https://github.com/apache/carbondata.git
-$ cd python/pycarbon
+$ cd python
$ pip install . --user
@@ -14,7 +14,7 @@ $ pip install . --user
## how to use
if you have a CarbonData dataset, you can use PyCarbon to read data. For the
generation of CarbonData dataset, you can see the examples:
-`generate_dataset_carbon.py` in tests/hello_world/dataset_with_unischema.
+`generate_dataset_carbon.py` in
pycarbon/tests/hello_world/dataset_with_unischema.
But user should do some config first:
- config pyspark and add carbon assembly jar to pyspark/jars folder, which
can be compiled from CarbonData project.
@@ -35,7 +35,7 @@ But user should do some config first:
.write \
.save(path=dset_output_url, format='carbon')
```
-some details are illustrated in `generate_pycarbon_mnist.py
<https://github.com/apache/carbondata/blob/master/python/pycarbon/tests/mnist/dataset_with_unischema/generate_pycarbon_mnist.py>`
in test/hello_world.
+some details are illustrated in
[generate_pycarbon_mnist.py](<https://github.com/apache/carbondata/blob/master/python/pycarbon/tests/mnist/dataset_with_unischema/generate_pycarbon_mnist.py>)
in pycarbon/test/hello_world.
### PyCarbon Reader API
@@ -107,7 +107,7 @@ def make_tensor(reader):
print(sample.id)
```
-some details are illustrated in `tf_example_carbon_unified_api.py
<https://github.com/apache/carbondata/blob/master/python/pycarbon/tests/mnist/dataset_with_unischema/tf_example_carbon_unified_api.py>`
in tests/mnist.
+some details are illustrated in
[tf_example_carbon_unified_api.py](<https://github.com/apache/carbondata/blob/master/python/pycarbon/tests/mnist/dataset_with_unischema/tf_example_carbon_unified_api.py>)
in pycarbon/tests/mnist.
#### Part of result:
@@ -153,7 +153,7 @@ def make_data_loader(reader, batch_size=1):
train(model, device, train_loader, args.log_interval, optimizer, epoch)
```
-some details are illustrated in `pytorch_example_carbon_unified_api.py
<https://github.com/apache/carbondata/blob/master/python/pycarbon/tests/mnist/dataset_with_unischema/pytorch_example_carbon_unified_api.py>`
in tests/mnist.
+some details are illustrated in
[pytorch_example_carbon_unified_api.py](<https://github.com/apache/carbondata/blob/master/python/pycarbon/tests/mnist/dataset_with_unischema/pytorch_example_carbon_unified_api.py>)
in pycarbon/tests/mnist.
#### Part of result:
```python