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

Removed pip install deeplake[enterprise] references in docs #2688

Merged
merged 3 commits into from Nov 14, 2023

Conversation

nvoxland
Copy link
Contributor

@nvoxland nvoxland commented Nov 6, 2023

🚀 🚀 Pull Request

Impact

  • Bug fix (non-breaking change which fixes expected existing functionality)
  • Enhancement/New feature (adds functionality without impacting existing logic)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Doc changes

Description

No need to pip install deeplake[enterprise] anymore, so removed references to it.

Things to worry about

Did a search in this repo for 'deeplake[enterprise]" . Is there other places that need to be changed that got missed?

@@ -4764,7 +4763,6 @@ def max_view(self):
def random_split(self, lengths: Sequence[Union[int, float]]):
"""Splits the dataset into non-overlapping :class:`~deeplake.core.dataset.Dataset` objects of given lengths.
If a list of fractions that sum up to 1 is given, the lengths will be computed automatically as floor(frac * len(dataset)) for each fraction provided.
The split generated is only performant with enterprise dataloader which can be installed with ``pip install deeplake[enterprise]``.
Copy link
Contributor

Choose a reason for hiding this comment

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

We should say: This feature is only compatible with the high-performance dataloader.

I asked @levongh to figure out what happens when this is used with OSS dataloader. I'm honestly not sure.

@@ -398,7 +398,7 @@ def evaluate(

if not INDRA_INSTALLED:
raise ImportError(
"indra is not installed. Please install indra to use this functionality with: pip install `deeplake[enterprise]`"
"The C++ library is not installed."
Copy link
Contributor

Choose a reason for hiding this comment

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

We should add. 'The library should be installed using pip install deeplake, but if you want to install it separately, you may run pip install libdeeplake.'

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated this, take a look now

@@ -99,7 +99,7 @@ def dataset_to_pytorch(
for t in tensors:
if dataset[t].is_sequence:
raise NotImplementedError(
f"Deep Lake’s OSS pure-python dataloader is not compatible with tensor `{t}` with htype = sequence[…]. Please use the C++ dataloader via ds.dataloader(…), which can be installed using ‘pip install deeplake[enterprise]’."
f"Deep Lake’s OSS pure-python dataloader is not compatible with tensor `{t}` with htype = sequence[…]. Please use the C++ dataloader via ds.dataloader(…)"
Copy link
Contributor

Choose a reason for hiding this comment

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

Instead of C++ dataloader, let's say 'high-performance dataloader'. That's consistent with language Levon is using in indra

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, I like that better than mentioning the language. Users don't care what we implement it in

Copy link

codecov bot commented Nov 6, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (fce0d9f) 84.24% compared to head (1a9d74c) 71.90%.

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #2688       +/-   ##
===========================================
- Coverage   84.24%   71.90%   -12.35%     
===========================================
  Files         231      231               
  Lines       25856    25856               
===========================================
- Hits        21783    18592     -3191     
- Misses       4073     7264     +3191     
Flag Coverage Δ
unittests 71.90% <ø> (-12.35%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
deeplake/core/dataset/dataset.py 80.23% <ø> (-12.06%) ⬇️
deeplake/core/dataset/deeplake_query_dataset.py 69.71% <ø> (-18.31%) ⬇️
deeplake/core/vectorstore/deep_memory.py 73.57% <ø> (-20.73%) ⬇️
deeplake/integrations/pytorch/pytorch.py 96.87% <ø> (ø)

... and 103 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

sonarcloud bot commented Nov 7, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@istranic istranic self-requested a review November 7, 2023 17:42
@nvoxland nvoxland merged commit 9a01de0 into main Nov 14, 2023
10 of 14 checks passed
@nvoxland nvoxland deleted the no_enterprise_in_docs branch November 14, 2023 16:20
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

4 participants