new empty pages #3766

imanjra · 2023-11-02T21:41:47Z

What changes are proposed in this pull request?

Add new empty pages for the cases below:

When there are no datasets in FiftyOne

When there are datasets in FiftyOne, but none is selected

When a dataset is selected, but there are no samples in the dataset

How is this patch tested? If it is not, please explain why.

See preview above

Release Notes

Is this a user-facing change that should be mentioned in the release notes?

No. You can skip the rest of this section.
Yes. Give a description of this change to be included in the release
notes for FiftyOne users.

See above

What areas of FiftyOne does this PR affect?

App: FiftyOne application changes
Build: Build and test infrastructure changes
Core: Core fiftyone Python library changes
Documentation: FiftyOne documentation changes
Other

codecov · 2023-11-03T22:02:06Z

Codecov Report

Attention: 823 lines in your changes are missing coverage. Please review.

Comparison is base (e0e6505) 15.57% compared to head (0203130) 15.52%.
Report is 13 commits behind head on develop.

Files	Patch %	Lines
app/packages/core/src/components/Starter/index.tsx	0.00%	243 Missing ⚠️
.../src/plugins/SchemaIO/components/LazyFieldView.tsx	0.00%	92 Missing ⚠️
...pp/packages/core/src/components/Starter/content.ts	0.00%	75 Missing ⚠️
app/packages/operators/src/state.ts	0.00%	70 Missing ⚠️
app/packages/operators/src/hooks.ts	0.00%	69 Missing ⚠️
app/packages/operators/src/loader.tsx	0.00%	54 Missing ⚠️
app/packages/operators/src/types.ts	0.00%	46 Missing ⚠️
...kages/components/src/components/CodeTabs/index.tsx	29.50%	43 Missing ⚠️
app/packages/operators/src/built-in-operators.ts	0.00%	30 Missing ⚠️
app/packages/state/src/recoil/modal.ts	33.33%	20 Missing ⚠️
... and 18 more

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #3766      +/-   ##
===========================================
- Coverage    15.57%   15.52%   -0.05%     
===========================================
  Files          645      653       +8     
  Lines        74120    74834     +714     
  Branches       990      996       +6     
===========================================
+ Hits         11542    11620      +78     
- Misses       62578    63214     +636

Flag	Coverage Δ
app	`15.52% <8.85%> (-0.05%)`	⬇️

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

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

brimoor

These new pages are looking awesome! Here's some suggested copy tweaks for each page:

No datasets

No datasets yet

# If the `@voxel51/utils/create_dataset` plugin is installed
[Click here](open @voxel51/utils/create_dataset) to create a new dataset, or [browse operations](open operator browser) for other options

# If the `@voxel51/utils/create_dataset` plugin is not installed
Did you know? You can create datasets in the App by installing the [@voxel51/utils](https://github.com/voxel51/fiftyone-plugins/tree/main/plugins/utils) plugin, or [browse operations](open operator browser) for other options

[Learn more](https://docs.voxel51.com/user_guide/dataset_creation/index.html) about loading data into FiftyOne

Create dataset with code

You can use Python to [load data](https://docs.voxel51.com/user_guide/dataset_creation/index.html) into FiftyOne

import fiftyone as fo

# A name for the dataset
name = "my-dataset"

# The directory containing the data to import
dataset_dir = "/path/to/data"

# The type of data being imported
dataset_type = fo.types.COCODetectionDataset

dataset = fo.Dataset.from_dir(
    dataset_dir=dataset_dir,
    dataset_type=dataset_type,
    name=name,
)

No dataset selected

You can use the selector above to open an existing dataset

# If the `@voxel51/utils/create_dataset` plugin is installed
[Click here](open @voxel51/utils/create_dataset) to create a new dataset, or [browse operations](open operator browser) for other options

# If the `@voxel51/utils/create_dataset` plugin is not installed
Did you know? You can create datasets in the App by installing the [@voxel51/utils](https://github.com/voxel51/fiftyone-plugins/tree/main/plugins/utils) plugin, or [browse operations](open operator browser) for other options

Select a dataset with code

You can use Python to load a dataset in the App

import fiftyone as fo

# Name of an existing dataset
name = "quickstart"

dataset = fo.load_dataset(name)

# Launch a new App session
session = fo.launch_app(dataset)

# If you already have an active App session
# session.dataset = dataset

Dataset with no samples

No samples yet

# If the `@voxel51/io/import_samples` plugin is installed
[Click here](open @voxel51/io/import_samples) to add samples to this dataset, or [browse operations](open operator browser) for other options

# If the `@voxel51/io/import_samples` plugin is not installed
Did you know? You can add samples to datasets in the App by installing the [@voxel51/io](https://github.com/voxel51/fiftyone-plugins/tree/main/plugins/io) plugin, or [browse operations](open operator browser) for other options

[Learn more](https://docs.voxel51.com/user_guide/dataset_creation/index.html#custom-formats) about loading data into FiftyOne

Add samples with code

You can use Python to [add samples](https://docs.voxel51.com/user_guide/dataset_creation/index.html) to this dataset

import fiftyone as fo

dataset = fo.load_dataset("$CURRENT_DATASET_NAME")

samples = []
for filepath, label in zip(filepaths, labels):
    sample = fo.Sample(filepath=filepath)
    sample["ground_truth"] = fo.Classification(label=label)
    samples.append(sample)

dataset.add_samples(samples)

brimoor

LGTM from a copy standpoint! 🥇

brimoor · 2023-11-10T21:44:25Z

@imanjra this is super minor, but is it easy to introduce a minimum width for the code blocks? Some of them look a bit narrow (although all code is visible, of course). I'd suggest 80 characters wide since that's our Python style 🤓

It could even be a fixed width layout where anything longer causes horizontal scrolling (which we should make every effect to avoid with our canned code snippets)

manivoxel51

nice work! 🍨

Pulled and tested with an empty dataset.

Thoughts for later: For people checking out FO UI (without the SDK) it might be worth to have a button or operator that can populate the empty dataset with random images/videos so that the user can explore the app with a click of a button

manivoxel51 · 2023-11-14T18:12:54Z

app/packages/app/src/pages/datasets/DatasetPage.tsx

@@ -75,6 +76,8 @@ const DatasetPageQueryNode = graphql`
 const DatasetPage: Route<DatasetPageQuery> = ({ prepared }) => {
  const data = usePreloadedQuery(DatasetPageQueryNode, prepared);
  const isModalActive = Boolean(useRecoilValue(fos.isModalActive));
+  const count = useRecoilValue(fos.datasetSampleCount);


cool, so this is not based on for example filters returning 0 samples but actual sample count of a dataset

Indeed. This count should not factor in filters applied.

ritch · 2023-11-14T20:06:41Z

app/packages/operators/src/built-in-operators.ts

-    registerOperator(SplitPanel);
-    registerOperator(SetSelectedLabels);
-    registerOperator(ClearSelectedLabels);
+    _registerBuiltInOperator(CopyViewAsJSON);


Looking at the diff it looks like some built in operators are removed..?

I have refactored the operator loading and move some of the loading code out of this file. I have updated registerOperator with _registerBuiltInOperator to bind to built-in plugin. However, I will check to make sure they are not gone from the list 👍

benjaminpkane

🚀

benjaminpkane · 2023-11-14T21:19:54Z

app/packages/app/src/pages/datasets/DatasetPage.tsx

@@ -15,6 +15,7 @@ import Nav from "../../components/Nav";
 import { Route } from "../../routing";
 import style from "../index.module.css";
 import { DatasetPageQuery } from "./__generated__/DatasetPageQuery.graphql";
+import Starter from "@fiftyone/core/src/components/Starter";


Small import nit. It's good to be explicit about what packages the core library exports I think

Suggested change

import Starter from "@fiftyone/core/src/components/Starter";

import { Starter } from "@fiftyone/core";

imanjra · 2023-11-14T23:36:38Z

Thoughts for later: For people checking out FO UI (without the SDK) it might be worth to have a button or operator that can populate the empty dataset with random images/videos so that the user can explore the app with a click of a button

Good idea. We do have several core operators in https://github.com/voxel51/fiftyone-plugins which allows creating, importing samples, loading zoo datasets and much more right from the app.

imanjra force-pushed the feat/empty-page branch from a4cd1f0 to 3961dfa Compare November 3, 2023 15:18

imanjra marked this pull request as ready for review November 3, 2023 15:26

imanjra requested a review from a team November 3, 2023 15:47

imanjra changed the base branch from estimated-counts to develop November 3, 2023 15:48

imanjra requested a review from benjaminpkane November 3, 2023 15:48

imanjra force-pushed the feat/empty-page branch from 3961dfa to 993511a Compare November 3, 2023 21:59

brimoor requested changes Nov 7, 2023

View reviewed changes

imanjra force-pushed the feat/empty-page branch 4 times, most recently from d4ff536 to 34afbfd Compare November 7, 2023 19:42

brimoor approved these changes Nov 7, 2023

View reviewed changes

imanjra force-pushed the feat/empty-page branch from 34afbfd to e57c3de Compare November 7, 2023 19:54

imanjra mentioned this pull request Nov 9, 2023

sync placement loading with native actions #3793

Merged

7 tasks

imanjra force-pushed the feat/empty-page branch from e43978a to 3e2127d Compare November 13, 2023 23:13

manivoxel51 approved these changes Nov 14, 2023

View reviewed changes

ritch reviewed Nov 14, 2023

View reviewed changes

benjaminpkane approved these changes Nov 14, 2023

View reviewed changes

imanjra added 5 commits November 14, 2023 19:18

minor cleanup for loading of operators

ffaf275

new empty pages

7e4988f

set min width for starter code

a2ed5c4

export components for starter page in core package

fbcbf39

sync placement loading with native actions

0203130

imanjra force-pushed the feat/empty-page branch from ddabc55 to 0203130 Compare November 15, 2023 00:19

imanjra merged commit 279935c into develop Nov 15, 2023
12 of 13 checks passed

imanjra deleted the feat/empty-page branch November 15, 2023 13:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

new empty pages #3766

new empty pages #3766

imanjra commented Nov 2, 2023 •

edited

codecov bot commented Nov 3, 2023 •

edited

brimoor left a comment •

edited

brimoor left a comment

brimoor commented Nov 10, 2023

manivoxel51 left a comment

manivoxel51 Nov 14, 2023

imanjra Nov 14, 2023

ritch Nov 14, 2023

imanjra Nov 14, 2023

benjaminpkane left a comment

benjaminpkane Nov 14, 2023

imanjra commented Nov 14, 2023

	import Starter from "@fiftyone/core/src/components/Starter";
	import { Starter } from "@fiftyone/core";

new empty pages #3766

new empty pages #3766

Conversation

imanjra commented Nov 2, 2023 • edited

What changes are proposed in this pull request?

Add new empty pages for the cases below:

When there are no datasets in FiftyOne

When there are datasets in FiftyOne, but none is selected

When a dataset is selected, but there are no samples in the dataset

How is this patch tested? If it is not, please explain why.

Release Notes

Is this a user-facing change that should be mentioned in the release notes?

What areas of FiftyOne does this PR affect?

codecov bot commented Nov 3, 2023 • edited

Codecov Report

brimoor left a comment • edited

Choose a reason for hiding this comment

No datasets

No datasets yet

Create dataset with code

No dataset selected

No dataset selected

Select a dataset with code

Dataset with no samples

No samples yet

Add samples with code

brimoor left a comment

Choose a reason for hiding this comment

brimoor commented Nov 10, 2023

manivoxel51 left a comment

Choose a reason for hiding this comment

manivoxel51 Nov 14, 2023

Choose a reason for hiding this comment

imanjra Nov 14, 2023

Choose a reason for hiding this comment

ritch Nov 14, 2023

Choose a reason for hiding this comment

imanjra Nov 14, 2023

Choose a reason for hiding this comment

benjaminpkane left a comment

Choose a reason for hiding this comment

benjaminpkane Nov 14, 2023

Choose a reason for hiding this comment

imanjra commented Nov 14, 2023

imanjra commented Nov 2, 2023 •

edited

codecov bot commented Nov 3, 2023 •

edited

brimoor left a comment •

edited