Skip to content

Commit

Permalink
docs: Update Changelog.md for new release
Browse files Browse the repository at this point in the history
  • Loading branch information
FlorianSchepersAA committed May 6, 2024
1 parent c87c1bb commit fc7f9e7
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 18 deletions.
39 changes: 22 additions & 17 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,26 @@
# Changelog

## Unreleased
- feature: `AlephAlphaModel` now supports a `context_size`-property

### Breaking Changes
...

### New Features
- Add new `IncrementalEvaluator` for easier addition of runs to existing evaluations without repeated evaluation.
- Add `IncrementalEvaluationLogic` for use in `IncrementalEvaluator`
...

### Fixes
...

### Deprecations
...

## 1.1.0

### New Features
- `AlephAlphaModel` now supports a `context_size`-property
- Add new `IncrementalEvaluator` for easier addition of runs to existing evaluations without repeated evaluation.
- Add `IncrementalEvaluationLogic` for use in `IncrementalEvaluator`

## 1.0.0

Initial stable release
Expand All @@ -24,35 +29,35 @@ With the release of version 1.0.0 there have been introduced some new features b
Apart from these changes, we also had to reset our commit history, so please be aware of this fact.

### Breaking Changes
- breaking_change: The TraceViewer has been exported to its own repository and can be accessed via the artifactory [here]( https://alephalpha.jfrog.io.)
- breaking_change: `HuggingFaceDatasetRepository` now has a parameter caching, which caches examples of a dataset once loaded.
- The TraceViewer has been exported to its own repository and can be accessed via the artifactory [here]( https://alephalpha.jfrog.io.)
- `HuggingFaceDatasetRepository` now has a parameter caching, which caches examples of a dataset once loaded.
- `True` as default value
- set to `False` for **non-breaking**-change


### New Features
#### Llama2 and LLama3 model support
- feature: Introduction of `LLama2InstructModel` allows support of the LLama2-models:
- Introduction of `LLama2InstructModel` allows support of the LLama2-models:
- `llama-2-7b-chat`
- `llama-2-13b-chat`
- `llama-2-70b-chat`
- feature: Introduction of `LLama3InstructModel` allows support of the LLama2-models:
- Introduction of `LLama3InstructModel` allows support of the LLama2-models:
- `llama-3-8b-instruct`
- `llama-3-70b-instruct`
#### DocumentIndexClient
`DocumentIndexClient` has been enhanced with the following set of features:
- feature: `create_index`
- `create_index`
- feature `index_configuration`
- feature: `assign_index_to_collection`
- feature: `delete_index_from_collection`
- feature: `list_assigned_index_names`
- `assign_index_to_collection`
- `delete_index_from_collection`
- `list_assigned_index_names`

#### Miscellaneous
- feature: `ExpandChunks`-task now caches chunked documents by ID
- feature: `DocumentIndexRetriever` now supports `index_name`
- feature: `Runner.run_dataset` now has a configurable number of workers via `max_workers` and defaults to the previous value, which is 10.
- feature: In case a `BusyError` is raised during a `complete` the `LimitedConcurrencyClient` will retry until `max_retry_time` is reached.
- `ExpandChunks`-task now caches chunked documents by ID
- `DocumentIndexRetriever` now supports `index_name`
- `Runner.run_dataset` now has a configurable number of workers via `max_workers` and defaults to the previous value, which is 10.
- In case a `BusyError` is raised during a `complete` the `LimitedConcurrencyClient` will retry until `max_retry_time` is reached.

### Fixes
- fix: `HuggingFaceRepository` no longer is a dataset repository. This also means that `HuggingFaceAggregationRepository` no longer is a dataset repository.
- fix: The input parameter of the `DocumentIndex.search()`-function now has been renamed from `index` to `index_name`
- `HuggingFaceRepository` no longer is a dataset repository. This also means that `HuggingFaceAggregationRepository` no longer is a dataset repository.
- The input parameter of the `DocumentIndex.search()`-function now has been renamed from `index` to `index_name`
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"

[tool.poetry]
name = "intelligence-layer"
version = "1.0.0"
version = "1.1.0"
description = ""
authors = ["Aleph Alpha Engineering <[email protected]>"]
readme = "README.md"
Expand Down

0 comments on commit fc7f9e7

Please sign in to comment.