docs: adjust readme according to suggestions#577
Conversation
Codecov Report
@@ Coverage Diff @@
## main #577 +/- ##
=======================================
Coverage 86.40% 86.40%
=======================================
Files 134 134
Lines 6714 6714
=======================================
Hits 5801 5801
Misses 913 913
Flags with carried forward coverage won't be shown. Click here to find out more. Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
NicholasDunham
left a comment
There was a problem hiding this comment.
A couple of minor grammatical changes. Separate from those, I'm not sure about the "If you have XGB of RAM" part—is a specific amount of RAM required, or do we just want to say "If you have a lot of RAM"?
|
With the X amount of RAM I meant an approximate minimum of usable RAM that you need to have, in order to execute the readme example with the full dataset. I cannot test the actual RAM usage of a run with the full dataset myself since I have only 16G available. When trying out the example at todays Hackathon (at Jina in Berlin) everyone who tested the examples was running into this issue. |
yes X amount is a placeholder, I have to compute this. I have tried now and I could not manage to have it working without crashing and I have 16 GB RAM. How much memory u need to run this? from docarray import DocumentArray
left_da = DocumentArray.pull('demo-leftda', show_progress=False)
from docarray import Document
def preproc(d: Document):
return (
d.load_uri_to_image_tensor() # load
.set_image_tensor_normalization() # normalize color
.set_image_tensor_channel_axis(-1, 0)
) # switch color axis for the PyTorch model later
left_da.apply(preproc)
import torchvision
model = torchvision.models.resnet50(pretrained=True) # load ResNet50
left_da.embed(model, device='cpu')
right_da = (
DocumentArray.pull('demo-rightda', show_progress=True)
.apply(preproc)
.embed(model, device='cpu')
)
left_da.match(right_da, limit=9) |
Co-authored-by: Nicholas Dunham <[email protected]>
|
📝 Docs are deployed on https://ft-fix-example-4-readme--jina-docs.netlify.app 🎉 |
NicholasDunham
left a comment
There was a problem hiding this comment.
One more wording change. Other than that, looks good.
Co-authored-by: Nicholas Dunham <[email protected]>
8cadd31 to
e6cb3b0
Compare
Goals:
Adjust to suggestions to help people follow readme in an easier way