From 8b623918ed908076f112d86e0953999e7172461f Mon Sep 17 00:00:00 2001 From: steve pousty Date: Fri, 28 Mar 2025 16:06:45 -0700 Subject: [PATCH 1/2] moving these to their proper location --- .../basic => fiftyone_concepts}/install.md | 20 +++++++++---------- .../troubleshooting.md | 6 +++--- .../basic => fiftyone_concepts}/virtualenv.md | 0 3 files changed, 13 insertions(+), 13 deletions(-) rename docs/{getting_started/basic => fiftyone_concepts}/install.md (88%) rename docs/{getting_started/basic => fiftyone_concepts}/troubleshooting.md (97%) rename docs/{getting_started/basic => fiftyone_concepts}/virtualenv.md (100%) diff --git a/docs/getting_started/basic/install.md b/docs/fiftyone_concepts/install.md similarity index 88% rename from docs/getting_started/basic/install.md rename to docs/fiftyone_concepts/install.md index b422daf31..11d2f452a 100644 --- a/docs/getting_started/basic/install.md +++ b/docs/fiftyone_concepts/install.md @@ -3,7 +3,7 @@ Note Need to collaborate on your datasets? Check out -[FiftyOne Teams](../../teams/index.md#fiftyone-teams)! +[FiftyOne Teams](../teams/index.md#fiftyone-teams)! ## Prerequisites [¶](\#prerequisites "Permalink to this headline") @@ -50,8 +50,8 @@ If you want to work with video datasets, you’ll also need to install ## Quickstart [¶](\#quickstart "Permalink to this headline") Dive right into FiftyOne by opening a Python shell and running the snippet -below, which downloads a [small dataset](../../data/dataset_zoo/datasets.md#dataset-zoo-quickstart) and -launches the [FiftyOne App](../../fiftyone_concepts/app.md#fiftyone-app) so you can explore it! +below, which downloads a [small dataset](../data/dataset_zoo/datasets.md#dataset-zoo-quickstart) and +launches the [FiftyOne App](app.md#fiftyone-app) so you can explore it! ```python import fiftyone as fo @@ -64,7 +64,7 @@ session = fo.launch_app(dataset) Note that if you are running this code in a script, you must include [`session.wait()`](../../api/fiftyone.core.session.html#fiftyone.core.session.Session.wait "fiftyone.core.session.Session.wait") to block execution -until you close the App. See [this page](../../fiftyone_concepts/app.md#creating-an-app-session) for +until you close the App. See [this page](app.md#creating-an-app-session) for more information. ## Troubleshooting [¶](\#troubleshooting "Permalink to this headline") @@ -165,8 +165,8 @@ a dataset for the first time in a newer version of FiftyOne. Note If you are working with a -[custom/shared MongoDB database](../../fiftyone_concepts/config.md#configuring-mongodb-connection), you -can use [database admin privileges](../../fiftyone_concepts/config.md#database-migrations) to control +[custom/shared MongoDB database](config.md#configuring-mongodb-connection), you +can use [database admin privileges](config.md#database-migrations) to control which clients are allowed to upgrade your FiftyOne deployment. ## Downgrading FiftyOne [¶](\#downgrading-fiftyone "Permalink to this headline") @@ -175,7 +175,7 @@ If you need to downgrade to an older version of FiftyOne for any reason, you can do so. Since new releases occasionally introduce backwards-incompatible changes to the -data model, you must use the [fiftyone migrate](../../cli/index.md#cli-fiftyone-migrate) +data model, you must use the [fiftyone migrate](../cli/index.md#cli-fiftyone-migrate) command to perform any necessary downward database migrations **before installing the older version of FiftyOne**. @@ -198,7 +198,7 @@ fiftyone migrate --info If you are reading this after encountering an error resulting from downgrading your `fiftyone` package without first running -[fiftyone migrate](../../cli/index.md#cli-fiftyone-migrate), don’t worry, you simply need to +[fiftyone migrate](../cli/index.md#cli-fiftyone-migrate), don’t worry, you simply need to reinstall the newer version of FiftyOne and then follow these instructions. See [this page](troubleshooting.md#troubleshooting-downgrades) if you need to install @@ -207,8 +207,8 @@ FiftyOne v0.7.3 or earlier. Note If you are working with a -[custom/shared MongoDB database](../../fiftyone_concepts/config.md#configuring-mongodb-connection), you -can use [database admin privileges](../../fiftyone_concepts/config.md#database-migrations) to control +[custom/shared MongoDB database](config.md#configuring-mongodb-connection), you +can use [database admin privileges](config.md#database-migrations) to control which clients are allowed to downgrade your FiftyOne deployment. ## Uninstalling FiftyOne [¶](\#uninstalling-fiftyone "Permalink to this headline") diff --git a/docs/getting_started/basic/troubleshooting.md b/docs/fiftyone_concepts/troubleshooting.md similarity index 97% rename from docs/getting_started/basic/troubleshooting.md rename to docs/fiftyone_concepts/troubleshooting.md index 371d062b3..5600f5396 100644 --- a/docs/getting_started/basic/troubleshooting.md +++ b/docs/fiftyone_concepts/troubleshooting.md @@ -122,14 +122,14 @@ pip install ipython FiftyOne includes a `fiftyone-db` package wheel for your operating system and hardware. If you have not -[configured your own database connection](../../fiftyone_concepts/config.md#configuring-mongodb-connection), +[configured your own database connection](config.md#configuring-mongodb-connection), then FiftyOne’s database service will attempt to start up on import using the MongoDB distribution provided by `fiftyone-db`. If the database fails to start, importing `fiftyone` will result in exceptions being raised. ## Downgrading to old versions [¶](\#downgrading-to-old-versions "Permalink to this headline") -The [fiftyone migrate](../../cli/index.md#cli-fiftyone-migrate) command was introduced in +The [fiftyone migrate](../cli/index.md#cli-fiftyone-migrate) command was introduced in FiftyOne v0.7.3. If you would like to downgrade from a FiftyOne version prior to v0.7.3 (to a yet older version), then you will first need to [upgrade](install.md#upgrading-fiftyone) to v0.7.3 or later and then @@ -185,7 +185,7 @@ sudo apt install libssl-dev ``` If you still face issues with imports, you can follow -[these instructions](../../fiftyone_concepts/config.md#configuring-mongodb-connection) to configure +[these instructions](config.md#configuring-mongodb-connection) to configure FiftyOne to use a MongoDB instance that you have installed yourself. ### Troubleshooting Windows imports [¶](\#troubleshooting-windows-imports "Permalink to this headline") diff --git a/docs/getting_started/basic/virtualenv.md b/docs/fiftyone_concepts/virtualenv.md similarity index 100% rename from docs/getting_started/basic/virtualenv.md rename to docs/fiftyone_concepts/virtualenv.md From e9a68f3cdff99ed14309ce76e238a2b45f0a5823 Mon Sep 17 00:00:00 2001 From: steve pousty Date: Fri, 28 Mar 2025 16:31:50 -0700 Subject: [PATCH 2/2] moving these to their proper location --- mkdocs.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 147b151e7..a440a0483 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -62,8 +62,6 @@ nav: - Installing: getting_started/basic/install.md - Basics: - getting_started/basic/index.md - - Installing: getting_started/basic/install.md - - Virtualenvs: getting_started/basic/virtualenv.md - Datasets, Samples, and Fields: getting_started/basic/datasets_samples_fields.md - Tour of the Application: getting_started/basic/application_tour.md - Visualizing Embeddings: getting_started/basic/viz_embeddings.md @@ -73,12 +71,13 @@ nav: - Model Fine-Tuning: getting_started/basic/fine_tuning.md - Model Evaluation: getting_started/basic/model_eval.md - What's Next: getting_started/basic/next_steps.md - - Troubleshooting: getting_started/basic/troubleshooting.md - Focused Getting Starteds: - getting_started/focused_getting_starteds/index.md - Medical Imaging: getting_started/focused_getting_starteds/medical_imaging/index.md - FiftyOne Concepts: - fiftyone_concepts/index.md + - Virtualenvs: fiftyone_concepts/virtualenv.md + - Installation: fiftyone_concepts/install.md - Basics: fiftyone_concepts/basics.md - Running Environments: fiftyone_concepts/running_environments.md - Loading Data into FiftyOne: @@ -96,7 +95,8 @@ nav: - Exporting Datasets: fiftyone_concepts/export_datasets.md - Drawing Labels on Samples: fiftyone_concepts/draw_labels.md - Configuring FiftyOne: fiftyone_concepts/config.md - - Machine Learning (FiftyOne Brain): fiftyone_concepts/brain.md + - FiftyOne Brain (Machine Learning): fiftyone_concepts/brain.md + - Troubleshooting: fiftyone_concepts/troubleshooting.md - How Do I: - how_do_i/index.md - Cheat Sheets: how_do_i/cheat_sheets/index.md