From 33e15f90f93eb1f23b3d7f13ae866533673571fe Mon Sep 17 00:00:00 2001 From: Kristian Aune Date: Fri, 20 Dec 2024 17:20:21 +0100 Subject: [PATCH] proofreading --- en/content/idealstate.html | 2 +- en/document-api-guide.html | 2 +- en/embedding.html | 2 +- en/federation.html | 2 +- en/getting-started.html | 2 +- en/grouping.html | 4 ++-- en/jdisc/index.html | 2 +- en/linguistics.html | 2 +- en/operations-selfhosted/docker-containers.html | 2 +- en/operations-selfhosted/vespa-cmdline-tools.html | 2 +- en/operations/tools.html | 2 +- en/partial-updates.html | 2 +- en/performance/sizing-feeding.html | 2 +- en/performance/valgrind.html | 2 +- en/proton.html | 6 +++--- en/reference/query-api-reference.html | 2 +- en/reference/rank-features.html | 6 +++--- en/reference/ranking-expressions.html | 2 +- en/reference/schema-reference.html | 8 ++++---- en/reference/services-search.html | 4 ++-- en/reference/validation-overrides.html | 6 +++--- en/streaming-search.html | 2 +- en/testing.html | 2 +- en/vespa-cli.html | 2 +- en/vespa7-release-notes.html | 10 +++++----- en/visiting.html | 2 +- 26 files changed, 41 insertions(+), 41 deletions(-) diff --git a/en/content/idealstate.html b/en/content/idealstate.html index 5cff0c6604..e33346b897 100644 --- a/en/content/idealstate.html +++ b/en/content/idealstate.html @@ -124,7 +124,7 @@

A simple example: Modulo

Weighted random election

This is the algorithm that is currently used for distribution in the content layer, - as it fits our usecase well. + as it fits our use case well.

To avoid a total redistribution on state change, the mapping can not be heavily dependent on the number of nodes in the cluster. diff --git a/en/document-api-guide.html b/en/document-api-guide.html index 4652de6434..657a6a7371 100644 --- a/en/document-api-guide.html +++ b/en/document-api-guide.html @@ -342,7 +342,7 @@

AsyncSession

or update that needs to be handled.
  • Note that the client must process the response queue or your JVM will run into garbage collection issues, as the underlying session keeps track of all responses - and unless they are consumed they will be kept alive and not be gc'ed.
  • + and unless they are consumed they will be kept alive and not be garbage collected.

    Example:

    diff --git a/en/embedding.html b/en/embedding.html
    index ecd45c5e83..40818900c1 100644
    --- a/en/embedding.html
    +++ b/en/embedding.html
    @@ -563,7 +563,7 @@ 

    Adding a fixed string to a query
    {% highlight json %}
     {
         "yql": "select * from doc where userQuery() or ({targetHits: 100}nearestNeighbor(embedding, e))",
    -    "input.query(e)": "embed(mxai, @text)",
    +    "input.query(e)": "embed(mxbai, @text)",
         "user_query": "space contains many suns"
     }
     {% endhighlight %}
    diff --git a/en/federation.html b/en/federation.html index ea537ce1b4..cf55c5858f 100644 --- a/en/federation.html +++ b/en/federation.html @@ -27,7 +27,7 @@ articles.
  • provide more comprehensive results by finding data from alternative sources in the cases where the application has none, - like backfilling web results.
  • + like back-filling web results.
  • create applications whose main purpose is not to provide access to some data set but to provide users or frontend applications a single starting point to access many kinds of data from various diff --git a/en/getting-started.html b/en/getting-started.html index 134c27d1f8..10ce03cf92 100644 --- a/en/getting-started.html +++ b/en/getting-started.html @@ -91,7 +91,7 @@ Embedding Model Inference

    - Vespa supports integrating embedding models, this avoids transfering large amounts of embedding vector data + Vespa supports integrating embedding models, this avoids transferring large amounts of embedding vector data over the network and allows for efficient serving of embedding models.

    • Huggingface Embedder Use single-vector embedding models from Hugging face
    • diff --git a/en/grouping.html b/en/grouping.html index fad0cf166b..70a6d65228 100644 --- a/en/grouping.html +++ b/en/grouping.html @@ -448,7 +448,7 @@

      Ordering and Limiting Groups

      Example: To find the 2 globally best groups, make an educated guess on how many samples are needed to fetch from each node in order to get the right groups. This is the precision. - An initial factor of 3 has proven to be quite good in most usecases. + An initial factor of 3 has proven to be quite good in most use cases. If however the data for customer 'Jones' was spread on 3 different content nodes, 'Jones' might be among the 2 best on only one node. But based on the distribution of the data, @@ -1899,7 +1899,7 @@

      Impression forecasting

      So if the rank score is 0.420 for a specific user/ad/bid combination, then interpolatedlookup(impressions,relevance()) would return 5.0. -If the bid is increased so the rankscore gets to 0.490, +If the bid is increased so the rank score gets to 0.490, it would get 5.5 as the return value instead.

      In this context a count of 5.5 isn't meaningful for the past of a single user, diff --git a/en/jdisc/index.html b/en/jdisc/index.html index d04876297b..221584af25 100644 --- a/en/jdisc/index.html +++ b/en/jdisc/index.html @@ -15,7 +15,7 @@

    • Dependency injection based on Guice (Felix), but extended for configs and component collections.
    • A component model based on OSGi which allows - component to be (re)deployed to running servers, and to control which API's they expose to others.
    • + component to be (re)deployed to running servers, and to control which APIs they expose to others.
    • The features above combine to allow application package changes (changes to components, configuration or data) to be applied by Vespa without disrupting request serving nor requiring restarts.
    • Standard component types exists for diff --git a/en/linguistics.html b/en/linguistics.html index fd9eb7a897..9e05351809 100644 --- a/en/linguistics.html +++ b/en/linguistics.html @@ -76,7 +76,7 @@

      Default languages

    • Irish (ga)
    • Italian (it)
    • Norwegian (nb)
    • -
    • Portugese (pt)
    • +
    • Portuguese (pt)
    • Romanian (ro)
    • Russian (ru)
    • Spanish (es)
    • diff --git a/en/operations-selfhosted/docker-containers.html b/en/operations-selfhosted/docker-containers.html index 052bf139ce..f85462a410 100644 --- a/en/operations-selfhosted/docker-containers.html +++ b/en/operations-selfhosted/docker-containers.html @@ -176,7 +176,7 @@

      Graceful stop

      (i.e. data structures are flushed). If the container is shutdown forcefully, the content nodes might need to restore the state from the transaction log which might be time-consuming. - There is no chance of data loss or data corruption as the data is always written and sync'ed to persistent storage. + There is no chance of data loss or data corruption as the data is always written and synced to persistent storage.

      The default timeout for the Docker daemon to wait for the shutdown diff --git a/en/operations-selfhosted/vespa-cmdline-tools.html b/en/operations-selfhosted/vespa-cmdline-tools.html index 9b51edce72..9c7cdf8ab7 100644 --- a/en/operations-selfhosted/vespa-cmdline-tools.html +++ b/en/operations-selfhosted/vespa-cmdline-tools.html @@ -384,7 +384,7 @@

      vespa-fbench-filter-file

       usage: vespa-fbench-filter-file [-a] [-h] [-m maxLineSize]
       
      -Read concatenated fastserver logs from stdin and write
      +Read concatenated logs from stdin and write
       extracted query urls to stdout.
       
        -a       : all parameters to the original query urls are preserved.
      diff --git a/en/operations/tools.html b/en/operations/tools.html
      index ad08b40372..7142dcf0b7 100644
      --- a/en/operations/tools.html
      +++ b/en/operations/tools.html
      @@ -153,7 +153,7 @@ 

      vespa-fbench

      -x - write benchmarkdata-reporting to output file: + write benchmark data reporting to output file: diff --git a/en/partial-updates.html b/en/partial-updates.html index bd9843d2d1..83b9d91ef0 100644 --- a/en/partial-updates.html +++ b/en/partial-updates.html @@ -164,7 +164,7 @@

      Write pipeline

      Attribute data is periodically flushed, see attribute-flush. Note that operations are persisted to the Transaction Log Service (TLS), in the rare case of a power failure or unclean shutdown, - the operations are synched from the TLS. + the operations are synced from the TLS.

      diff --git a/en/performance/sizing-feeding.html b/en/performance/sizing-feeding.html index a204161de3..c408410539 100644 --- a/en/performance/sizing-feeding.html +++ b/en/performance/sizing-feeding.html @@ -59,7 +59,7 @@

      Stateful content cluster

      The write pattern is append and sequential (not random) IO. Note that Vespa cannot sustain a higher write rate than - the underlaying storage can handle. Feeding might be impacted severely if the content nodes are using network attached storage + the underlying storage can handle. Feeding might be impacted severely if the content nodes are using network attached storage where the sync operation (for durability) has a much higher cost than on local attached storage (e.g. SSD). See sync-transactionlog.

      diff --git a/en/performance/valgrind.html b/en/performance/valgrind.html index 1213bed3bc..998f1c4ecf 100644 --- a/en/performance/valgrind.html +++ b/en/performance/valgrind.html @@ -27,7 +27,7 @@

      Valgrind with callgrind

       $ valgrind 'application'
       
      -

      Show callgraph:

      +

      Show call graph:

       $ valgrind --tool=callgrind 'application'
       
      diff --git a/en/proton.html b/en/proton.html index b4dec34625..5c03091d8f 100644 --- a/en/proton.html +++ b/en/proton.html @@ -207,9 +207,9 @@

      Transaction log

      Having a transaction log simplifies proton's in-memory index structures and enables steady-state high performance, read more below.

      -All operations are written and synched to the transaction log. +All operations are written and synced to the transaction log. This is sequential (not random) IO but might impact overall feed performance if running on NAS attached storage -where the synch operation has a much higher cost than on local attached storage (e.g. SSD). +where the sync operation has a much higher cost than on local attached storage (e.g. SSD). See sync-transactionlog.

      @@ -225,7 +225,7 @@

      Document store

      Documents are stored as compressed serialized blobs in the document store. Put, update and remove operations are persisted in the transaction log before updating the document in the document store. - The operation is ack'ed to the client and the result of the operation is immediately seen in search results. + The operation is acked to the client and the result of the operation is immediately seen in search results.

      Files in the document store are written sequentially, and occur in pairs - example: diff --git a/en/reference/query-api-reference.html b/en/reference/query-api-reference.html index 9c92075b61..350e80ccbb 100644 --- a/en/reference/query-api-reference.html +++ b/en/reference/query-api-reference.html @@ -1622,7 +1622,7 @@

      Tracing

      Default is no information. See trace.profileDepth for semantics of this parameter.

      -

      Tracing with trace.profiling.secondhaseRanking.depth also requires that trace.level is positive.

      +

      Tracing with trace.profiling.secondphaseRanking.depth also requires that trace.level is positive.

      diff --git a/en/reference/rank-features.html b/en/reference/rank-features.html index 5ee4bde5f7..66321df0bc 100644 --- a/en/reference/rank-features.html +++ b/en/reference/rank-features.html @@ -16,7 +16,7 @@

      • - Types: All rank feature values are floats. Ints are converted to exact whole value floats. + Types: All rank feature values are floats. Integers are converted to exact whole value floats. String values are converted to exact whole value floats using a hash function. String literals in ranking expressions are converted using the same hash function, to enable equality tests on string values. @@ -1371,7 +1371,7 @@

        Rank scores

      diff --git a/en/reference/schema-reference.html b/en/reference/schema-reference.html index 1414814f92..890883e86a 100644 --- a/en/reference/schema-reference.html +++ b/en/reference/schema-reference.html @@ -2121,13 +2121,13 @@

      second-phase

      @@ -3051,7 +3051,7 @@

      angular

      If possible, it's slightly better for performance to normalize both query and document vectors to the same L2 norm and use the prenormalized-angular metric instead; but note that returned - distance and closeness will be differerent. + distance and closeness will be different.

      dotproduct

      diff --git a/en/reference/services-search.html b/en/reference/services-search.html index 020f2332f1..765900826a 100644 --- a/en/reference/services-search.html +++ b/en/reference/services-search.html @@ -341,7 +341,7 @@

      significance

      </significance>

      -The models are either provided by Vespa or generated with vespa-signficance tool. +The models are either provided by Vespa or generated with vespa-significance tool. The order determines model precedence - with the last element having the highest priority. To use these models, schema needs to enable significance models in the rank-profile.

      @@ -365,7 +365,7 @@

      model

      A model specified with url and path are JSON files, which can be also compressed with zstandard. -Model files can be generated using vespa-signficance tool. +Model files can be generated using vespa-significance tool. Example with url:

      diff --git a/en/reference/validation-overrides.html b/en/reference/validation-overrides.html
      index d0c99d79ac..5875bc4759 100644
      --- a/en/reference/validation-overrides.html
      +++ b/en/reference/validation-overrides.html
      @@ -98,7 +98,7 @@ 

      List of validation overrides

      - + @@ -123,7 +123,7 @@

      List of validation overrides

      - + @@ -153,7 +153,7 @@

      List of validation overrides

      - +
      6400M

      - The euclidian distance from the query position to the given position attribute in millionths of degrees (about 10 cm). + The Euclidean distance from the query position to the given position attribute in millionths of degrees (about 10 cm). If there are multiple positions in the query, items that actually search in name is preferred. Also: if multiple query items search in name, or name is an array of positions, or both, the closest distance found is returned. @@ -1419,7 +1419,7 @@

      Rank scores

      6400M

      - The euclidian distance from a path through 2d space + The Euclidean distance from a path through 2d space given in the query to the given position attribute in millionths of degrees. This is useful e.g. for finding the closest locations to a given road. The query path is set in the diff --git a/en/reference/ranking-expressions.html b/en/reference/ranking-expressions.html index 13321b929a..79ca771619 100644 --- a/en/reference/ranking-expressions.html +++ b/en/reference/ranking-expressions.html @@ -579,7 +579,7 @@

      Non-primitive functions

      atan2(t1, t2)

      join(t1, t2, f(x,y)(atan2(x,y)))

      -

      Arctangent of t1 and t2/

      +

      Arc tangent of t1 and t2/

      expression

      Specify the ranking expression to be used for second phase of ranking. (for a description, see the ranking expression documentation.

      -

      Hits not reranked might be rescored using a linear function to avoid a greater rank score than the worst reranked hit. This linear function will normally attempt to map the first phase rank score range of reranked hits to the reranked rank score range

      +

      Hits not reranked might be re-scored using a linear function to avoid a greater rank score than the worst reranked hit. This linear function will normally attempt to map the first phase rank score range of reranked hits to the reranked rank score range

      rank-score-drop-limit

      - When set, drop all hits with a second phase rank score (possibly a rescored rank score) less than or equal to this floating point number. + When set, drop all hits with a second phase rank score (possibly a re-scored rank score) less than or equal to this floating point number. Use this to implement a second phase rank cutoff. By default, this value is not set. This can also be set in the query.

      @@ -2139,7 +2139,7 @@

      second-phase

      Optional argument. Specifies the number of hits to be re-ranked in the second phase. Default value is 100. This can also be set in the query. Note that this value is local to each node involved in a query. - Hits not reranked might be rescored. + Hits not reranked might be re-scored.

      field-type-change Field type changes.Requires refeeding data.Requires re-feeding data.
      tensor-type-change
      deployment-removal Removal of production zones from deployment.xml.Causes removal of all clustersand data in the zones.Causes removal of all clusters and data in the zones.
      global-document-change
      certificate-removal Removing data plane certificates, typically when moving to new certificates.Unable to accesss endpoint with removed certificates.Unable to access endpoint with removed certificates.
      diff --git a/en/streaming-search.html b/en/streaming-search.html index f05268bec2..4735109ffa 100644 --- a/en/streaming-search.html +++ b/en/streaming-search.html @@ -231,7 +231,7 @@

      On Vespa Cloud, this number is set automatically to match the number of VCPUs set in resources. -If you cannot get lower latency by increasing vcpus, it means your streaming searches have become +If you cannot get lower latency by increasing VCPUs, it means your streaming searches have become IO bound.

      diff --git a/en/testing.html b/en/testing.html index 2709d1115a..bf0dac8d6c 100644 --- a/en/testing.html +++ b/en/testing.html @@ -136,7 +136,7 @@

      Staging tests

      As opposed to system tests, staging tests are not self-contained, as the state change during upgrade is precisely what is tested. Instead, execution order of any staging tests that modify state, particularly - after upgrade, must be controlled. Indeed, some changes will require refeeding data, and this should then be + after upgrade, must be controlled. Indeed, some changes will require re-feeding data, and this should then be part of the staging test code. Finally, it is also good to verify the expected state prior to upgrade.

      diff --git a/en/vespa-cli.html b/en/vespa-cli.html index 9a3422ff6c..a48c795d84 100644 --- a/en/vespa-cli.html +++ b/en/vespa-cli.html @@ -141,7 +141,7 @@

      Documents

      $ cat docs.json | vespa feed - # Feed to Vespa Cloud -$ vespa feed --application mytenant.mayapp -target https://b123e1db.b68a1234.z.vespa-app.cloud feedfile.json +$ vespa feed --application mytenant.myapp -target https://b123e1db.b68a1234.z.vespa-app.cloud feedfile.json # Print successful and failed operations: $ vespa feed --verbose docs.json diff --git a/en/vespa7-release-notes.html b/en/vespa7-release-notes.html index f815dc5138..7e870e3038 100644 --- a/en/vespa7-release-notes.html +++ b/en/vespa7-release-notes.html @@ -18,7 +18,7 @@ means that applications which use functionality that has earlier been deprecated need to change to keep working.

      Most deprecated functionality causes warning during compilation (Java API deprecations) or deployment - (application package deprecations), however with web service API's there is no way to emit deprecation warnings, + (application package deprecations), however with web service APIs there is no way to emit deprecation warnings, and we have to rely on marking these as deprecated in the documentation.

      Given this, application owners need to do 3 tasks to be compatible with Vespa 7:

      @@ -27,7 +27,7 @@
    • Review whether changes to defaults requires additional settings in the application (note that this is likely on changing from 6 to 7 due to the changes to tokenization and stemming).
    • Make sure there are no deprecation warnings on compilation and deployment on Vespa 6. -
    • Review the list of removed web service API's and API parameters and make sure these are not used by clients of +
    • Review the list of removed web service APIs and API parameters and make sure these are not used by clients of the application.
    @@ -111,10 +111,10 @@

    JDK version

    correct set of imported packages for your OSGi bundles.

    -

    Removed Java API's

    +

    Removed Java APIs

    Classes and methods that were marked as deprecated in Vespa 6 are removed. -If you get deprecation warnings for Vespa API's when building your +If you get deprecation warnings for Vespa APIs when building your application, they must be fixed before migrating to Vespa 7.

    @@ -135,7 +135,7 @@

    Container Runtime Environment

    -

    Removed HTTP API's

    +

    Removed HTTP APIs

    The following HTTP APIs are removed:

    diff --git a/en/visiting.html b/en/visiting.html index beb85eaca7..11ad9260eb 100644 --- a/en/visiting.html +++ b/en/visiting.html @@ -104,7 +104,7 @@

    Performance note: f means that the stream of documents is no longer uniformly distributed across buckets and/or content nodes. Prior to Vespa 8.349 this is likely to greatly reduce feeding performance due to increased contention around backend bucket-level write locks and indexing threads. Vespa -8.349 and beyond contains optimizations that bring refeeding performance much closer to +8.349 and beyond contains optimizations that bring re-feeding performance much closer to that of initial feeding.