🚨 BREAKING CHANGES 0.9.0 -> 1.0.0

nan-wang commented 3 years ago

This issue is created to keep track of breaking changes between 0.9.0 and 1.0.0 (scheduled release on Feb. 15, 2021)

Current version is

Breaking Changes & Migration Guide

PR	Rolled Out?	Override
#1722	yes	#1739
#1739	yes

Remove separate_workspace. Instead of using pea_workspace, shard_workspace is defined based on the workspace, thenameand thepea_id. Setworkspacemetas default toNone. Introduceroot_workspaceandroot_nameto resolve the workspace issue inCompoundExecutorandref_indexer. Usecomplete_pathto finduses_internalresource tobindintodockerwhen spinning apeain acontainer`

	v0.9.0	v1.0.0
	_{```python f = Flow().add(uses='NumpyIndexer', shards=2, separated_workspace=True) ```}	_{```python f = Flow().add(uses='NumpyIndexer', shards=2) # saved files # ├── jina.executors.indexers.vector.NumpyIndexer-86342edc-1 # │ ├── jina.executors.indexers.vector.NumpyIndexer-86342edc # │ └── jina.executors.indexers.vector.NumpyIndexer-86342edc.bin # └── jina.executors.indexers.vector.NumpyIndexer-c4f2ea6c-2 # └── jina.executors.indexers.vector.NumpyIndexer-c4f2ea6c ```}

PR	Rolled Out?	Override
#1632	yes

Separate Segmenter from Crafter. Segmenter is used to segment each Document into several Documents. In comparison, Crafter is used to process each Document and the output is still only one Document.

	v0.9.0	v1.0.0
	_{```python from jina.executors.crafters import BaseSegmenter class DummySentencizer(BaseSegmenter): def craft(self, text, args, *kwargs): results = {} for t in text.split(','): results.append({'text': t}) return results return results ```}	_{```python from jina.executors.segmenters import BaseSegmenter class DummySentencizer(BaseSegmenter): def segment(self, text, args, *kwargs): results = {} for t in text.split(','): results.append({'text': t}) return results return results ```}

PR	Rolled Out?	Override
#1580	yes	#1757
#1757	yes	#1766
#1766	yes

jina/logging/sse.py is removed. Correspondingly, '--logserver' and '--logserver-config' options are removed from CLI. To use log streaming, please refer to the api.jina.ai

PR	Rolled Out?	Override
#1677	yes	#1764
#1764	yes

Replace batch_size in the python client with request_size to avoid misunderstanding.

	v0.9.0	v1.0.0
	_{```python with Flow().add() as f: f.index([ Document(text='hello, jina') for _ in range(10)], batch_size=3) ```}	_{```python with Flow().add() as f: f.index([ Document(text='hello, jina') for _ in range(10)], request_size=3) ```}

PR	Rolled Out?	Override
#1729	yes

Replace MinRanker with SimpleAggregateRanker.

	v0.9.0	v1.0.0
	_{```python f = (Flow() .add(uses='NumpyIndexer') .add(uses='MinRanker')) with f: f.search([Document(embedding=np.random.rand(10))]) ```}	_{```python f = (Flow() .add(uses='NumpyIndexer') .add(uses='SimpleAggregateRanker', aggregate_function='min', is_reversed_score=True)) with f: f.search([Document(embedding=np.random.rand(10))]) ```}

PR	Rolled Out?	Override
#1730	yes

Deprecate output_fn, callback and buffer for the Flow API

PR	Rolled Out?	Override
#1816	yes

Add support to use async generator in both inputs and outputs of AsyncFlow.

	v0.9.0	v1.0.0
	_{```python async def input_fn(): for _ in range(10): yield Document() await asyncio.sleep(0.1) with AsyncFlow().add() as f: await f.index(input_fn) ```}	_{```python from jina import AsyncFlow async def input_fn(): for _ in range(10): yield Document() await asyncio.sleep(0.1) with AsyncFlow().add() as f: async for resp in f.index(input_fn): print(resp) ```}

PR	Rolled Out?	Override
#1828	yes

Move docs from https://github.com/jina-ai/jina/ to https://github.com/jina-ai/docs

PR	Rolled Out?	Override
#1823	yes

delete API of Flow accepts a sequence of Documents IDs instead of Documents; refactor the DeleteRequestProto in the jina.proto; add docs and groundtruths fields in the DeleteRequestProto; replace the to_response method with as_response in the Request class; replace the to_json method with json in the Request class;

	v0.9.0	v1.0.0
	_{```python from jina import Flow f = Flow().add(uses='_index') with f: f.delete([Document(id=_id) for _id in ['🐦', '🐲']]) ```}	_{```python from jina import Flow f = Flow().add(uses='_index') with f: f.delete(['🐦', '🐲']) ```}

PR	Rolled Out?	Override
#1831	yes

Rename DocIDCache to DocCache

PR	Rolled Out?	Override
#1829	yes

Make VectorIndexer only use str as keys; query_by_id is replaced with query_by_key

	v0.9.0	v1.0.0
	_{```python vec_idx = array([0, 1]) with NumpyIndexer.load(save_abspath) as indexer: for idx in vec_idx: retrieved_vec = indexer.query_by_id(idx) ```}	_{```python vec_idx = array(['0', '1'], dtype=(np.str_, 16)) with NumpyIndexer.load(save_abspath) as indexer: for key in vec_idx: retrieved_vec = indexer.query_by_key(ke) ```}

PR	Rolled Out?	Override
#1847	yes

Unify the calling of protobuf object to .proto; replace as_pb_object with proto for Message; replace proto in BaseNdArray, NdArray, SparseNdArray with _pb_body to avoid misunderstanding; replace _querylang with _pb_body in QueryLang; replace _request with _pb_body in Request; replace _score with _pb_body in NamedScore

PR	Rolled Out?	Override
#1858	yes

Remove groundtruths from the UpdatedRequestProto

PR	Rolled Out?	Override
#1872	yes

Remove UniqueId

Template

PR	Rolled Out?	Override
#1722	yes

	v0.9.0	v1.0.0
	_{```python old codes ```}	_{```python new codes ```}

hanxiao commented 3 years ago

0.9.3->0.9.4 Changelog is lost due to a bug in release.sh, please use scripts/release.sh:L59 to retrieve it back

function make_release_note {
    ${RELEASENOTE} ${LAST_VER}..HEAD .github/release-template.ejs > ./CHANGELOG.tmp
    head -n10 ./CHANGELOG.tmp
    printf '\n%s\n\n%s\n%s\n\n%s\n\n%s\n\n' "$(cat ./CHANGELOG.md)" "<a name="release-note-${RELEASE_VER//\./-}"></a>" "## Release Note (\`${RELEASE_VER}\`)" "> Release time: $(date +'%Y-%m-%d %H:%M:%S')" "$(cat ./CHANGELOG.tmp)" > ./CHANGELOG.md
}

nan-wang commented 3 years ago

0.9.3->0.9.4 Changelog is lost due to a bug in release.sh, please use scripts/release.sh:L59 to retrieve it back

function make_release_note {
    ${RELEASENOTE} ${LAST_VER}..HEAD .github/release-template.ejs > ./CHANGELOG.tmp
    head -n10 ./CHANGELOG.tmp
    printf '\n%s\n\n%s\n%s\n\n%s\n\n%s\n\n' "$(cat ./CHANGELOG.md)" "<a name="release-note-${RELEASE_VER//\./-}"></a>" "## Release Note (\`${RELEASE_VER}\`)" "> Release time: $(date +'%Y-%m-%d %H:%M:%S')" "$(cat ./CHANGELOG.tmp)" > ./CHANGELOG.md
}

@hanxiao fixed in https://github.com/jina-ai/jina/pull/1645

florian-hoenicke commented 3 years ago

The attribute separated_workspace will be removed. The pea will always have it's own workspace in case pea_id >0 Also the pea_workspace meta will not exist anymore. https://github.com/jina-ai/jina/pull/1722

jina-ai / serve