From 6f2b7447b76861a974d19067556dcaa97a24431f Mon Sep 17 00:00:00 2001 From: Shivay-at-pieces <143828586+shivay-at-pieces@users.noreply.github.com> Date: Sun, 25 Aug 2024 08:13:37 +0000 Subject: [PATCH 1/6] fix question typo --- docs/build/sdks/python/copilot.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build/sdks/python/copilot.mdx b/docs/build/sdks/python/copilot.mdx index d12ce8ebe..ff7b04f46 100644 --- a/docs/build/sdks/python/copilot.mdx +++ b/docs/build/sdks/python/copilot.mdx @@ -40,7 +40,7 @@ for response in pieces_client.copilot.stream_question(question): pieces_client.close() ``` -If you do not want to stream the response, you can use the `quesiton()` method instead. +If you do not want to stream the response, you can use the `question()` method instead. #### Example From 9cc5d22be6f0e042419f13716f7a7dd04c329cd9 Mon Sep 17 00:00:00 2001 From: Shivay-at-pieces <143828586+shivay-at-pieces@users.noreply.github.com> Date: Sun, 25 Aug 2024 08:29:58 +0000 Subject: [PATCH 2/6] Link asset glossary term --- docs/build/sdks/python/quickstart.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/build/sdks/python/quickstart.mdx b/docs/build/sdks/python/quickstart.mdx index 8b6255651..eb516561b 100644 --- a/docs/build/sdks/python/quickstart.mdx +++ b/docs/build/sdks/python/quickstart.mdx @@ -80,10 +80,10 @@ pieces_client.close() ### Get All Assets -To get all your assets, you can use the `assets` method of the Pieces Client. Here's an example of how to get all your assets and print their names: +To get all your [assets](/build/glossary/terms/asset), you can use the `assets` method of the Pieces Client. Here's an example of how to get all your assets and print their names: ```python -from pieces_os_client.wrapper import PiecesClient +from pieces_os_client.wrapper import PiecesClientpnp # Initialize the PiecesClient pieces_client = PiecesClient() From e08a46d7d8cebb67ceeac543afde82d3f8f890b6 Mon Sep 17 00:00:00 2001 From: Debajyati Date: Wed, 4 Sep 2024 21:49:41 +0530 Subject: [PATCH 3/6] docs:fixed the pynvim installation command in quickstart Previously the provided command could successfully work in only Windows and MacOS. I added the command for Debian/Ubuntu/(Ubuntu based distros) because python packages are globally installed differently in a Linux OS. --- docs/extensions-plugins/neovim/quickstart.mdx | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/extensions-plugins/neovim/quickstart.mdx b/docs/extensions-plugins/neovim/quickstart.mdx index be3d10638..8966908ba 100644 --- a/docs/extensions-plugins/neovim/quickstart.mdx +++ b/docs/extensions-plugins/neovim/quickstart.mdx @@ -26,11 +26,18 @@ In this tutorial, we'll walk you through the process of setting up and using the A few things to note before you start installing the Pieces Neovim Plugin: -- The Python based Neovim plugins requires the `pynvim` Python package, which is not included in the default Neovim installation. You can install it by running the following command: +- The Python based Neovim plugins requires the `pynvim` Python package, which is not included in the default Neovim installation. + You can install it in MacOS/Windows by running the following command: ```bash pip install pynvim ``` + + If you use Debian/Ubuntu/Ubuntu-based-distro - + + ```bash + sudo apt install python3-pynvim + ``` - Ensure that you have at least one Neovim package manager installed. For instance, you can install `vim-plug`. In order to install `vim-plug`, run the following command in your terminal: From 2f74a24bc4960625f18b7c83bd0dc5067e77c8de Mon Sep 17 00:00:00 2001 From: Debajyati Date: Thu, 5 Sep 2024 21:12:37 +0530 Subject: [PATCH 4/6] fix: made requested changes Removed Debian from the line because only Ubuntu 22+ and Ubuntu based distros are supported by Pieces --- docs/extensions-plugins/neovim/quickstart.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/extensions-plugins/neovim/quickstart.mdx b/docs/extensions-plugins/neovim/quickstart.mdx index 8966908ba..5ecd9d39e 100644 --- a/docs/extensions-plugins/neovim/quickstart.mdx +++ b/docs/extensions-plugins/neovim/quickstart.mdx @@ -33,7 +33,7 @@ A few things to note before you start installing the Pieces Neovim Plugin: pip install pynvim ``` - If you use Debian/Ubuntu/Ubuntu-based-distro - + If you use Ubuntu 22+ or an Ubuntu-based-distro - ```bash sudo apt install python3-pynvim From 3f7bda318514d2f4259671839bc168afe4e7e091 Mon Sep 17 00:00:00 2001 From: Bishoy Hany <167128903+Bishoy-at-pieces@users.noreply.github.com> Date: Tue, 24 Sep 2024 22:07:34 +0300 Subject: [PATCH 5/6] fix typo --- docs/build/sdks/python/quickstart.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build/sdks/python/quickstart.mdx b/docs/build/sdks/python/quickstart.mdx index eb516561b..c811e1f31 100644 --- a/docs/build/sdks/python/quickstart.mdx +++ b/docs/build/sdks/python/quickstart.mdx @@ -83,7 +83,7 @@ pieces_client.close() To get all your [assets](/build/glossary/terms/asset), you can use the `assets` method of the Pieces Client. Here's an example of how to get all your assets and print their names: ```python -from pieces_os_client.wrapper import PiecesClientpnp +from pieces_os_client.wrapper import PiecesClient # Initialize the PiecesClient pieces_client = PiecesClient() From c98c5190f7810916660f39b45f316b7b0a7922e6 Mon Sep 17 00:00:00 2001 From: Mason Williams Date: Fri, 27 Sep 2024 16:48:43 -0400 Subject: [PATCH 6/6] docs: Update links and clean up documentation --- docs/build/glossary/terms/masked-language-modeling.md | 2 +- docs/build/reference/typescript/models/05-Activity.md | 2 +- docs/product-highlights-and-benefits/live-context.mdx | 2 -- 3 files changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/build/glossary/terms/masked-language-modeling.md b/docs/build/glossary/terms/masked-language-modeling.md index 448368ca3..9139b49bb 100644 --- a/docs/build/glossary/terms/masked-language-modeling.md +++ b/docs/build/glossary/terms/masked-language-modeling.md @@ -6,7 +6,7 @@ category: AIML Masked Language Modeling, or “MLM,” is a pre-training technique used in natural language processing (NLP) to enable a model to predict masked tokens within an input sequence. It is an approach that helps AI models learn a deep understanding of language context and structure without requiring labeled data, making MLM NLP an unsupervised learning method. -Unlike traditional language models that predict the next token in a sequence, MLM can utilize both the previous and subsequent tokens to predict a masked token. As a result, the model is able to better understand the [context](https://docs.pieces.app/build/glossary/terms/Pieces%20Specific/context) surrounding each word. +Unlike traditional language models that predict the next token in a sequence, MLM can utilize both the previous and subsequent tokens to predict a masked token. As a result, the model is able to better understand the [context](https://docs.pieces.app/build/glossary/terms/context) surrounding each word. ## Benefits of Masked Language Modeling - **Deep contextual understanding** - MLM trains using both left and right contexts of a word, leading to a nuanced understanding of language structure and usage, superior to traditional unidirectional models. diff --git a/docs/build/reference/typescript/models/05-Activity.md b/docs/build/reference/typescript/models/05-Activity.md index 604941533..5b2eed1d7 100644 --- a/docs/build/reference/typescript/models/05-Activity.md +++ b/docs/build/reference/typescript/models/05-Activity.md @@ -5,7 +5,7 @@ title: Activity | TypeScript SDK # Activity -consider a rename to Event? That being said if we go with event we need to think about a word to pre/post fix event because it is likely to be a reserved word. additional documentation: https://www.notion.so/getpieces/Activity-4da8de193733441f85f87b510235fb74 Notes: - user/asset/format are all optional, NOT required that one of these are present. - if mechanism == internal we will not display to the user. Thoughts around additional properties. - hmm dismissed array here, that is an array of strings, where the string is the userId that dismissed this notification? or we could potentially do it based on the os_ID. - +consider a rename to Event? That being said if we go with event we need to think about a word to pre/post fix event because it is likely to be a reserved word. Notes: - user/asset/format are all optional, NOT required that one of these are present. - if mechanism == internal we will not display to the user. Thoughts around additional properties. - hmm dismissed array here, that is an array of strings, where the string is the userId that dismissed this notification? or we could potentially do it based on the os_ID. - ## Properties diff --git a/docs/product-highlights-and-benefits/live-context.mdx b/docs/product-highlights-and-benefits/live-context.mdx index 177f62d83..b3e6903e2 100644 --- a/docs/product-highlights-and-benefits/live-context.mdx +++ b/docs/product-highlights-and-benefits/live-context.mdx @@ -45,8 +45,6 @@ You also can clear Workstream Pattern Engine data at any time, from a specific t Once you've enabled the Workstream Pattern Engine, go about your usual work for a few minutes, and then head to the Copilot Chats view in the Pieces for Developers Desktop App and select “New Chat.” In the “Set Context” section, tap the option labeled “Live Context." Like before, you can leverage any of our available models, on-device or cloud, to engage with Live Context in the Pieces Copilot, and you can use it across your toolchain to carry on conversations in your favorite IDE and browser. -