From 7e271cadaff466514422e8499269899b559a2bc7 Mon Sep 17 00:00:00 2001 From: Piotr Brzyski Date: Tue, 20 Aug 2024 12:04:00 -0700 Subject: [PATCH] Docs - update modules Summary: 1. Update all packages to their most recent versions. 2. Add missing dependencies. 3. Add `cheerio` module's version override until a new version of `cmfcmf/docusaurus-search-local` is released. (see here https://github.com/cmfcmf/docusaurus-search-local/pull/218) 4. Fix MDX pages failing to compile with docusaurus 3.5.2 Differential Revision: D61535847 --- .../ARK/mps/request_mps/mps_cli_guide.mdx | 255 ++++++------------ website/docs/ARK/sw_release_notes.mdx | 2 +- .../ARK/troubleshooting/desktop_app_logs.mdx | 4 +- .../core_code_snippets/data_provider.mdx | 12 +- .../aea_data_format.mdx | 36 +-- website/package.json | 54 ++-- 6 files changed, 141 insertions(+), 222 deletions(-) diff --git a/website/docs/ARK/mps/request_mps/mps_cli_guide.mdx b/website/docs/ARK/mps/request_mps/mps_cli_guide.mdx index 1080dd73e..5c979dda0 100644 --- a/website/docs/ARK/mps/request_mps/mps_cli_guide.mdx +++ b/website/docs/ARK/mps/request_mps/mps_cli_guide.mdx @@ -79,240 +79,155 @@ Project Aria MPS CLI settings can be customized via the mps.ini file. This file - - - + + + - + - - - + + + - - - + + + - + - - - + + + - - - + + + - + - - - + + + - - - + + + - - - + + + - + - - - + + + - + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - + - - - + + + - - - + + + - - - + + + - + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
Setting - Description - Default Value - SettingDescriptionDefault Value
General settings - General settings
log_dir - Where log files are saved for each run. The filename is the timestamp from when the request tool started running. - /tmp/logs/projectaria/mps/ - log_dirWhere log files are saved for each run. The filename is the timestamp from when the request tool started running./tmp/logs/projectaria/mps/
status_check_interval - How long the MPS CLI waits to check the status of data during the Processing stage. - 30 secs - status_check_intervalHow long the MPS CLI waits to check the status of data during the Processing stage.30 secs
HASH - HASH
concurrent_hashes - Maximum number of files that can be concurrently hashed - 4 - concurrent_hashesMaximum number of files that can be concurrently hashed4
chunk_size - Chunk size to use for hashing - 10MB - chunk_sizeChunk size to use for hashing10MB
Encryption - Encryption
chunk_size - Chunk size to use for encryption - 50MB - chunk_sizeChunk size to use for encryption50MB
concurrent_encryptions - Maximum number of files that can be concurrently encrypted - 4 - concurrent_encryptionsMaximum number of files that can be concurrently encrypted4
delete_encrypted_files - Whether to delete the encrypted files after upload is done. If you set this to false local disk usage will double, due to an encrypted copy of each file. - True. - delete_encrypted_filesWhether to delete the encrypted files after upload is done. If you set this to false local disk usage will double, due to an encrypted copy of each file.True.
Health Check - Health Check
concurrent_health_checks - Maximum number of VRS file healthchecks that can be run concurrently - 2 - concurrent_health_checksMaximum number of VRS file healthchecks that can be run concurrently2
Uploads - Uploads
backoff - The exponential back off factor for retries during failed uploads. The wait time between successive retries will increase with this factor. - 1.5 - backoffThe exponential back off factor for retries during failed uploads. The wait time between successive retries will increase with this factor.1.5
interval - Base delay between retries. - 20 secs - intervalBase delay between retries.20 secs
retries - Maximum number of retries before giving up. - 10 - retriesMaximum number of retries before giving up.10
concurrent_uploads - Maximum number of concurrent uploads. - 4 - concurrent_uploadsMaximum number of concurrent uploads.4
max_chunk_size - Maximum chunk size that can be used during uploads. - 100 MB - max_chunk_sizeMaximum chunk size that can be used during uploads.100 MB
min_chunk_size - The minimum upload chunk size. - 5 MB - min_chunk_sizeThe minimum upload chunk size.5 MB
smoothing_window_size - Size of the smoothing window to adjust the chunk size. This value defines the number of uploaded chunks that will be used to determine the next chunk size. - 10 - smoothing_window_sizeSize of the smoothing window to adjust the chunk size. This value defines the number of uploaded chunks that will be used to determine the next chunk size.10
target_chunk_upload_secs - Target time to upload a single chunk. If the chunks in a smoothing window take longer, we reduce the chunk size. If it takes less time, we increase the chunk size. - 3 secs - target_chunk_upload_secsTarget time to upload a single chunk. If the chunks in a smoothing window take longer, we reduce the chunk size. If it takes less time, we increase the chunk size.3 secs
GraphQL (Query the MPS backend for MPS Status) - GraphQL (Query the MPS backend for MPS Status)
backoff - This the exponential back off factor for retries for failed queries. The wait time between successive retries will increase with this factor - 1.5 - backoffThis the exponential back off factor for retries for failed queries. The wait time between successive retries will increase with this factor1.5
interval - Base delay between retries - 4 secs - intervalBase delay between retries4 secs
retries - Maximum number of retries before giving up - 3 - retriesMaximum number of retries before giving up3
Download - Download
backoff - This the exponential back off factor for retries during failed downloads. The wait time between successive retries will increase with this factor. - 1.5 - backoffThis the exponential back off factor for retries during failed downloads. The wait time between successive retries will increase with this factor.1.5
interval - Base delay between retries - 20 secs - intervalBase delay between retries20 secs
retries - Maximum number of retries before giving up - 10 - retriesMaximum number of retries before giving up10
chunk_size - The chunk size to use for downloads - 10MB - chunk_sizeThe chunk size to use for downloads10MB
concurrent_downloads - Number of concurrent downloads - 10 - concurrent_downloadsNumber of concurrent downloads10
delete_zip - The server will send the results in a zip file. This flag controls whether to delete the zip file after extraction or not - True - delete_zipThe server will send the results in a zip file. This flag controls whether to delete the zip file after extraction or notTrue
diff --git a/website/docs/ARK/sw_release_notes.mdx b/website/docs/ARK/sw_release_notes.mdx index e79388581..c74b2a3c2 100644 --- a/website/docs/ARK/sw_release_notes.mdx +++ b/website/docs/ARK/sw_release_notes.mdx @@ -308,7 +308,7 @@ MPS requests using the Desktop app have been slightly restructured, you no longe The Streaming button in the dashboard has been renamed to Preview, to better reflect the capability provided by the Desktop app. Use the [Client SDK with CLI](/ARK/sdk/sdk.mdx) to stream data. -Desktop app logs are now stored in ~/.aria/logs/aria_desktop_app_{date}_{time}.log +Desktop app logs are now stored in `~/.aria/logs/aria_desktop_app_{date}_{time}.log` * Please note, the streaming preview available through the Desktop app is optimized for Profile 12. diff --git a/website/docs/ARK/troubleshooting/desktop_app_logs.mdx b/website/docs/ARK/troubleshooting/desktop_app_logs.mdx index 9dca76156..c474e888f 100644 --- a/website/docs/ARK/troubleshooting/desktop_app_logs.mdx +++ b/website/docs/ARK/troubleshooting/desktop_app_logs.mdx @@ -32,7 +32,7 @@ open /Applications/Aria.app --args --log-output ``` 3. The Aria Desktop app should then open with logging enabled -4. The logs will be stored in ~/.aria/logs/aria_desktop_app_{date}_{time}.log +4. The logs will be stored in `~/.aria/logs/aria_desktop_app_{date}_{time}.log` 5. Logs will continue to be added to this file until you quit the app 6. If you generate logs at a later time, they will be appended to the end of these logs @@ -48,6 +48,6 @@ open /Applications/Aria.app --args --log-output ``` 3. The Aria Desktop app should then open with logging enabled. -4. The logs will be stored in The logs will be stored in ~/.aria/logs/aria_desktop_app_{date}_{time}.log +4. The logs will be stored in The logs will be stored in `~/.aria/logs/aria_desktop_app_{date}_{time}.log` 5. Logs will continue to be added to this file until you quit the app 6. If you generate logs at a later time, they will be appended to the end of these logs diff --git a/website/docs/data_utilities/core_code_snippets/data_provider.mdx b/website/docs/data_utilities/core_code_snippets/data_provider.mdx index 08bbdde81..9ef7e6619 100644 --- a/website/docs/data_utilities/core_code_snippets/data_provider.mdx +++ b/website/docs/data_utilities/core_code_snippets/data_provider.mdx @@ -111,9 +111,9 @@ Project Aria data has four kinds of TimeDomain entries. We strongly recommend al * TimeDomain.TIME_CODE - for multiple devices You can also search using three different time query options: -* TimeQueryOptions.BEFORE (default): last data with t <= t_query -* TimeQueryOptions.AFTER : first data with t >= t_query -* TimeQueryOptions.CLOSEST : the data where |t - t_query| is smallest +* TimeQueryOptions.BEFORE (default): last data with `t <= t_query` +* TimeQueryOptions.AFTER : first data with `t >= t_query` +* TimeQueryOptions.CLOSEST : the data where `|t - t_query|` is smallest ```python for stream_id in provider.get_all_streams(): @@ -133,9 +133,9 @@ for stream_id in provider.get_all_streams(): * TimeDomain::TimeCode - for multiple devices You can also search using three different time query options: -* TimeQueryOptions::Before : last data with t <= t_query -* TimeQueryOptions::After : first data with t >= t_query -* TimeQueryOptions::Closest : the data where |t - t_query| is smallest +* TimeQueryOptions::Before : last data with `t <= t_query` +* TimeQueryOptions::After : first data with `t >= t_query` +* TimeQueryOptions::Closest : the data where `|t - t_query|` is smallest ```cpp for (const auto& streamId : provider.getAllStreams()) { diff --git a/website/docs/open_datasets/aria_everyday_activities_dataset/aea_data_format.mdx b/website/docs/open_datasets/aria_everyday_activities_dataset/aea_data_format.mdx index 1d280ec7d..06fb84142 100644 --- a/website/docs/open_datasets/aria_everyday_activities_dataset/aea_data_format.mdx +++ b/website/docs/open_datasets/aria_everyday_activities_dataset/aea_data_format.mdx @@ -40,34 +40,22 @@ Table 2: `speech.csv` Structure - - - - + + + + - - - - + + + + - - - - + + + +
startTime_ns - endTime_ns - written - confidence - startTime_nsendTime_nswrittenconfidence
54040 - 55040 - I’m - 0.25608 - 5404055040I’m0.25608
72920 - 73920 - looking - 0.84339 - 7292073920looking0.84339
diff --git a/website/package.json b/website/package.json index f49c20af1..4fb32e45d 100644 --- a/website/package.json +++ b/website/package.json @@ -20,29 +20,40 @@ "prettier:diff": "prettier --config .prettierrc --list-different \"**/*.{js,jsx,ts,tsx,md,mdx}\"" }, "dependencies": { - "@cmfcmf/docusaurus-search-local": "^1.1.0", - "@docusaurus/core": "2.4.1", - "@docusaurus/preset-classic": "2.4.1", - "@mdx-js/react": "^1.6.22", - "clsx": "^1.2.1", - "docusaurus-plugin-internaldocs-fb": "^1.12.0", - "react": "^17.0.2", - "react-dom": "^17.0.2", - "rehype-katex": "^3.0.0", - "remark-math": "^2.0.1" + "@algolia/client-search": "^5.1.0", + "@cmfcmf/docusaurus-search-local": "^1.2.0", + "@docusaurus/core": "^3.5.2", + "@docusaurus/preset-classic": "^3.5.2", + "@docusaurus/theme-classic": "^3.5.2", + "@mdx-js/react": "^3.0.1", + "@types/react": "^18.3.3", + "clsx": "^2.1.1", + "docusaurus-plugin-internaldocs-fb": "^1.18.4", + "react": "^18.3.1", + "react-dom": "^18.3.1", + "react-loadable": "^5.5.0", + "rehype-katex": "^7.0.1", + "remark-math": "^6.0.0", + "search-insights": "^2.16.3" }, "devDependencies": { - "@babel/eslint-parser": "^7.18.2", + "@babel/core": "^7.25.2", + "@babel/eslint-parser": "^7.25.1", + "@babel/helper-environment-visitor": "^7.24.7", + "@babel/helper-function-name": "^7.24.7", + "@babel/helper-hoist-variables": "^7.24.7", + "@babel/helper-split-export-declaration": "^7.24.7", "eslint": "^8.19.0", "eslint-config-airbnb": "^19.0.4", - "eslint-config-prettier": "^8.5.0", + "eslint-config-prettier": "^9.1.0", "eslint-plugin-header": "^3.1.1", - "eslint-plugin-import": "^2.26.0", - "eslint-plugin-jsx-a11y": "^6.6.0", - "eslint-plugin-react": "^7.30.1", - "eslint-plugin-react-hooks": "^4.6.0", - "prettier": "^2.7.1", - "stylelint": "^14.9.1" + "eslint-plugin-import": "^2.29.1", + "eslint-plugin-jsx-a11y": "^6.9.0", + "eslint-plugin-react": "^7.35.0", + "eslint-plugin-react-hooks": "^4.6.2", + "prettier": "^3.3.3", + "stylelint": "^16.8.2", + "typescript": "5.5.4" }, "browserslist": { "production": [ @@ -57,6 +68,11 @@ ] }, "engines": { - "node": ">=16.14" + "node": ">=18", + "npm": "use yarn instead", + "yarn": "^1.5" + }, + "resolutions": { + "cheerio": "1.0.0-rc.12" } }