mirror of https://github.com/immich-app/immich.git
feat(web,server)!: configure machine learning via the UI (#3768)
Jason Rasmussen
GitHub
parent
2cccef174a
commit
8211afb726
@ -1,98 +0,0 @@
|
|||||||
//
|
|
||||||
// AUTO-GENERATED FILE, DO NOT MODIFY!
|
|
||||||
//
|
|
||||||
// @dart=2.12
|
|
||||||
|
|
||||||
// ignore_for_file: unused_element, unused_import
|
|
||||||
// ignore_for_file: always_put_required_named_parameters_first
|
|
||||||
// ignore_for_file: constant_identifier_names
|
|
||||||
// ignore_for_file: lines_longer_than_80_chars
|
|
||||||
|
|
||||||
part of openapi.api;
|
|
||||||
|
|
||||||
class SearchConfigResponseDto {
|
|
||||||
/// Returns a new [SearchConfigResponseDto] instance.
|
|
||||||
SearchConfigResponseDto({
|
|
||||||
required this.enabled,
|
|
||||||
});
|
|
||||||
|
|
||||||
bool enabled;
|
|
||||||
|
|
||||||
@override
|
|
||||||
bool operator ==(Object other) => identical(this, other) || other is SearchConfigResponseDto &&
|
|
||||||
other.enabled == enabled;
|
|
||||||
|
|
||||||
@override
|
|
||||||
int get hashCode =>
|
|
||||||
// ignore: unnecessary_parenthesis
|
|
||||||
(enabled.hashCode);
|
|
||||||
|
|
||||||
@override
|
|
||||||
String toString() => 'SearchConfigResponseDto[enabled=$enabled]';
|
|
||||||
|
|
||||||
Map<String, dynamic> toJson() {
|
|
||||||
final json = <String, dynamic>{};
|
|
||||||
json[r'enabled'] = this.enabled;
|
|
||||||
return json;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Returns a new [SearchConfigResponseDto] instance and imports its values from
|
|
||||||
/// [value] if it's a [Map], null otherwise.
|
|
||||||
// ignore: prefer_constructors_over_static_methods
|
|
||||||
static SearchConfigResponseDto? fromJson(dynamic value) {
|
|
||||||
if (value is Map) {
|
|
||||||
final json = value.cast<String, dynamic>();
|
|
||||||
|
|
||||||
return SearchConfigResponseDto(
|
|
||||||
enabled: mapValueOfType<bool>(json, r'enabled')!,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
static List<SearchConfigResponseDto> listFromJson(dynamic json, {bool growable = false,}) {
|
|
||||||
final result = <SearchConfigResponseDto>[];
|
|
||||||
if (json is List && json.isNotEmpty) {
|
|
||||||
for (final row in json) {
|
|
||||||
final value = SearchConfigResponseDto.fromJson(row);
|
|
||||||
if (value != null) {
|
|
||||||
result.add(value);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return result.toList(growable: growable);
|
|
||||||
}
|
|
||||||
|
|
||||||
static Map<String, SearchConfigResponseDto> mapFromJson(dynamic json) {
|
|
||||||
final map = <String, SearchConfigResponseDto>{};
|
|
||||||
if (json is Map && json.isNotEmpty) {
|
|
||||||
json = json.cast<String, dynamic>(); // ignore: parameter_assignments
|
|
||||||
for (final entry in json.entries) {
|
|
||||||
final value = SearchConfigResponseDto.fromJson(entry.value);
|
|
||||||
if (value != null) {
|
|
||||||
map[entry.key] = value;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return map;
|
|
||||||
}
|
|
||||||
|
|
||||||
// maps a json object with a list of SearchConfigResponseDto-objects as value to a dart map
|
|
||||||
static Map<String, List<SearchConfigResponseDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
|
|
||||||
final map = <String, List<SearchConfigResponseDto>>{};
|
|
||||||
if (json is Map && json.isNotEmpty) {
|
|
||||||
// ignore: parameter_assignments
|
|
||||||
json = json.cast<String, dynamic>();
|
|
||||||
for (final entry in json.entries) {
|
|
||||||
map[entry.key] = SearchConfigResponseDto.listFromJson(entry.value, growable: growable,);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return map;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// The list of required keys that must be present in a JSON.
|
|
||||||
static const requiredKeys = <String>{
|
|
||||||
'enabled',
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
@ -0,0 +1,130 @@
|
|||||||
|
//
|
||||||
|
// AUTO-GENERATED FILE, DO NOT MODIFY!
|
||||||
|
//
|
||||||
|
// @dart=2.12
|
||||||
|
|
||||||
|
// ignore_for_file: unused_element, unused_import
|
||||||
|
// ignore_for_file: always_put_required_named_parameters_first
|
||||||
|
// ignore_for_file: constant_identifier_names
|
||||||
|
// ignore_for_file: lines_longer_than_80_chars
|
||||||
|
|
||||||
|
part of openapi.api;
|
||||||
|
|
||||||
|
class SystemConfigMachineLearningDto {
|
||||||
|
/// Returns a new [SystemConfigMachineLearningDto] instance.
|
||||||
|
SystemConfigMachineLearningDto({
|
||||||
|
required this.clipEncodeEnabled,
|
||||||
|
required this.enabled,
|
||||||
|
required this.facialRecognitionEnabled,
|
||||||
|
required this.tagImageEnabled,
|
||||||
|
required this.url,
|
||||||
|
});
|
||||||
|
|
||||||
|
bool clipEncodeEnabled;
|
||||||
|
|
||||||
|
bool enabled;
|
||||||
|
|
||||||
|
bool facialRecognitionEnabled;
|
||||||
|
|
||||||
|
bool tagImageEnabled;
|
||||||
|
|
||||||
|
String url;
|
||||||
|
|
||||||
|
@override
|
||||||
|
bool operator ==(Object other) => identical(this, other) || other is SystemConfigMachineLearningDto &&
|
||||||
|
other.clipEncodeEnabled == clipEncodeEnabled &&
|
||||||
|
other.enabled == enabled &&
|
||||||
|
other.facialRecognitionEnabled == facialRecognitionEnabled &&
|
||||||
|
other.tagImageEnabled == tagImageEnabled &&
|
||||||
|
other.url == url;
|
||||||
|
|
||||||
|
@override
|
||||||
|
int get hashCode =>
|
||||||
|
// ignore: unnecessary_parenthesis
|
||||||
|
(clipEncodeEnabled.hashCode) +
|
||||||
|
(enabled.hashCode) +
|
||||||
|
(facialRecognitionEnabled.hashCode) +
|
||||||
|
(tagImageEnabled.hashCode) +
|
||||||
|
(url.hashCode);
|
||||||
|
|
||||||
|
@override
|
||||||
|
String toString() => 'SystemConfigMachineLearningDto[clipEncodeEnabled=$clipEncodeEnabled, enabled=$enabled, facialRecognitionEnabled=$facialRecognitionEnabled, tagImageEnabled=$tagImageEnabled, url=$url]';
|
||||||
|
|
||||||
|
Map<String, dynamic> toJson() {
|
||||||
|
final json = <String, dynamic>{};
|
||||||
|
json[r'clipEncodeEnabled'] = this.clipEncodeEnabled;
|
||||||
|
json[r'enabled'] = this.enabled;
|
||||||
|
json[r'facialRecognitionEnabled'] = this.facialRecognitionEnabled;
|
||||||
|
json[r'tagImageEnabled'] = this.tagImageEnabled;
|
||||||
|
json[r'url'] = this.url;
|
||||||
|
return json;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Returns a new [SystemConfigMachineLearningDto] instance and imports its values from
|
||||||
|
/// [value] if it's a [Map], null otherwise.
|
||||||
|
// ignore: prefer_constructors_over_static_methods
|
||||||
|
static SystemConfigMachineLearningDto? fromJson(dynamic value) {
|
||||||
|
if (value is Map) {
|
||||||
|
final json = value.cast<String, dynamic>();
|
||||||
|
|
||||||
|
return SystemConfigMachineLearningDto(
|
||||||
|
clipEncodeEnabled: mapValueOfType<bool>(json, r'clipEncodeEnabled')!,
|
||||||
|
enabled: mapValueOfType<bool>(json, r'enabled')!,
|
||||||
|
facialRecognitionEnabled: mapValueOfType<bool>(json, r'facialRecognitionEnabled')!,
|
||||||
|
tagImageEnabled: mapValueOfType<bool>(json, r'tagImageEnabled')!,
|
||||||
|
url: mapValueOfType<String>(json, r'url')!,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
static List<SystemConfigMachineLearningDto> listFromJson(dynamic json, {bool growable = false,}) {
|
||||||
|
final result = <SystemConfigMachineLearningDto>[];
|
||||||
|
if (json is List && json.isNotEmpty) {
|
||||||
|
for (final row in json) {
|
||||||
|
final value = SystemConfigMachineLearningDto.fromJson(row);
|
||||||
|
if (value != null) {
|
||||||
|
result.add(value);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return result.toList(growable: growable);
|
||||||
|
}
|
||||||
|
|
||||||
|
static Map<String, SystemConfigMachineLearningDto> mapFromJson(dynamic json) {
|
||||||
|
final map = <String, SystemConfigMachineLearningDto>{};
|
||||||
|
if (json is Map && json.isNotEmpty) {
|
||||||
|
json = json.cast<String, dynamic>(); // ignore: parameter_assignments
|
||||||
|
for (final entry in json.entries) {
|
||||||
|
final value = SystemConfigMachineLearningDto.fromJson(entry.value);
|
||||||
|
if (value != null) {
|
||||||
|
map[entry.key] = value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return map;
|
||||||
|
}
|
||||||
|
|
||||||
|
// maps a json object with a list of SystemConfigMachineLearningDto-objects as value to a dart map
|
||||||
|
static Map<String, List<SystemConfigMachineLearningDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
|
||||||
|
final map = <String, List<SystemConfigMachineLearningDto>>{};
|
||||||
|
if (json is Map && json.isNotEmpty) {
|
||||||
|
// ignore: parameter_assignments
|
||||||
|
json = json.cast<String, dynamic>();
|
||||||
|
for (final entry in json.entries) {
|
||||||
|
map[entry.key] = SystemConfigMachineLearningDto.listFromJson(entry.value, growable: growable,);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return map;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The list of required keys that must be present in a JSON.
|
||||||
|
static const requiredKeys = <String>{
|
||||||
|
'clipEncodeEnabled',
|
||||||
|
'enabled',
|
||||||
|
'facialRecognitionEnabled',
|
||||||
|
'tagImageEnabled',
|
||||||
|
'url',
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
@ -1,27 +0,0 @@
|
|||||||
//
|
|
||||||
// AUTO-GENERATED FILE, DO NOT MODIFY!
|
|
||||||
//
|
|
||||||
// @dart=2.12
|
|
||||||
|
|
||||||
// ignore_for_file: unused_element, unused_import
|
|
||||||
// ignore_for_file: always_put_required_named_parameters_first
|
|
||||||
// ignore_for_file: constant_identifier_names
|
|
||||||
// ignore_for_file: lines_longer_than_80_chars
|
|
||||||
|
|
||||||
import 'package:openapi/api.dart';
|
|
||||||
import 'package:test/test.dart';
|
|
||||||
|
|
||||||
// tests for SearchConfigResponseDto
|
|
||||||
void main() {
|
|
||||||
// final instance = SearchConfigResponseDto();
|
|
||||||
|
|
||||||
group('test SearchConfigResponseDto', () {
|
|
||||||
// bool enabled
|
|
||||||
test('to test the property `enabled`', () async {
|
|
||||||
// TODO
|
|
||||||
});
|
|
||||||
|
|
||||||
|
|
||||||
});
|
|
||||||
|
|
||||||
}
|
|
||||||
@ -0,0 +1,47 @@
|
|||||||
|
//
|
||||||
|
// AUTO-GENERATED FILE, DO NOT MODIFY!
|
||||||
|
//
|
||||||
|
// @dart=2.12
|
||||||
|
|
||||||
|
// ignore_for_file: unused_element, unused_import
|
||||||
|
// ignore_for_file: always_put_required_named_parameters_first
|
||||||
|
// ignore_for_file: constant_identifier_names
|
||||||
|
// ignore_for_file: lines_longer_than_80_chars
|
||||||
|
|
||||||
|
import 'package:openapi/api.dart';
|
||||||
|
import 'package:test/test.dart';
|
||||||
|
|
||||||
|
// tests for SystemConfigMachineLearningDto
|
||||||
|
void main() {
|
||||||
|
// final instance = SystemConfigMachineLearningDto();
|
||||||
|
|
||||||
|
group('test SystemConfigMachineLearningDto', () {
|
||||||
|
// bool clipEncodeEnabled
|
||||||
|
test('to test the property `clipEncodeEnabled`', () async {
|
||||||
|
// TODO
|
||||||
|
});
|
||||||
|
|
||||||
|
// bool enabled
|
||||||
|
test('to test the property `enabled`', () async {
|
||||||
|
// TODO
|
||||||
|
});
|
||||||
|
|
||||||
|
// bool facialRecognitionEnabled
|
||||||
|
test('to test the property `facialRecognitionEnabled`', () async {
|
||||||
|
// TODO
|
||||||
|
});
|
||||||
|
|
||||||
|
// bool tagImageEnabled
|
||||||
|
test('to test the property `tagImageEnabled`', () async {
|
||||||
|
// TODO
|
||||||
|
});
|
||||||
|
|
||||||
|
// String url
|
||||||
|
test('to test the property `url`', () async {
|
||||||
|
// TODO
|
||||||
|
});
|
||||||
|
|
||||||
|
|
||||||
|
});
|
||||||
|
|
||||||
|
}
|
||||||
@ -1,3 +1,2 @@
|
|||||||
export * from './search-config-response.dto';
|
|
||||||
export * from './search-explore.response.dto';
|
export * from './search-explore.response.dto';
|
||||||
export * from './search-response.dto';
|
export * from './search-response.dto';
|
||||||
|
|||||||
@ -1,3 +0,0 @@
|
|||||||
export class SearchConfigResponseDto {
|
|
||||||
enabled!: boolean;
|
|
||||||
}
|
|
||||||
@ -0,0 +1,19 @@
|
|||||||
|
import { IsBoolean, IsUrl, ValidateIf } from 'class-validator';
|
||||||
|
|
||||||
|
export class SystemConfigMachineLearningDto {
|
||||||
|
@IsBoolean()
|
||||||
|
enabled!: boolean;
|
||||||
|
|
||||||
|
@IsUrl({ require_tld: false })
|
||||||
|
@ValidateIf((dto) => dto.enabled)
|
||||||
|
url!: string;
|
||||||
|
|
||||||
|
@IsBoolean()
|
||||||
|
clipEncodeEnabled!: boolean;
|
||||||
|
|
||||||
|
@IsBoolean()
|
||||||
|
facialRecognitionEnabled!: boolean;
|
||||||
|
|
||||||
|
@IsBoolean()
|
||||||
|
tagImageEnabled!: boolean;
|
||||||
|
}
|
||||||
@ -1,5 +1,6 @@
|
|||||||
export * from './dto';
|
export * from './dto';
|
||||||
export * from './response-dto';
|
export * from './response-dto';
|
||||||
export * from './system-config.constants';
|
export * from './system-config.constants';
|
||||||
|
export * from './system-config.core';
|
||||||
export * from './system-config.repository';
|
export * from './system-config.repository';
|
||||||
export * from './system-config.service';
|
export * from './system-config.service';
|
||||||
|
|||||||
@ -0,0 +1,104 @@
|
|||||||
|
<script lang="ts">
|
||||||
|
import {
|
||||||
|
notificationController,
|
||||||
|
NotificationType,
|
||||||
|
} from '$lib/components/shared-components/notification/notification';
|
||||||
|
import { handleError } from '$lib/utils/handle-error';
|
||||||
|
import { api, SystemConfigDto } from '@api';
|
||||||
|
import { isEqual } from 'lodash-es';
|
||||||
|
import { fade } from 'svelte/transition';
|
||||||
|
import SettingButtonsRow from '../setting-buttons-row.svelte';
|
||||||
|
import SettingInputField, { SettingInputFieldType } from '../setting-input-field.svelte';
|
||||||
|
import SettingSwitch from '../setting-switch.svelte';
|
||||||
|
|
||||||
|
let config: SystemConfigDto;
|
||||||
|
let defaultConfig: SystemConfigDto;
|
||||||
|
|
||||||
|
async function refreshConfig() {
|
||||||
|
[config, defaultConfig] = await Promise.all([
|
||||||
|
api.systemConfigApi.getConfig().then((res) => res.data),
|
||||||
|
api.systemConfigApi.getDefaults().then((res) => res.data),
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function reset() {
|
||||||
|
const { data: resetConfig } = await api.systemConfigApi.getConfig();
|
||||||
|
config = resetConfig;
|
||||||
|
notificationController.show({ message: 'Reset to the last saved settings', type: NotificationType.Info });
|
||||||
|
}
|
||||||
|
|
||||||
|
async function saveSetting() {
|
||||||
|
try {
|
||||||
|
const { data: current } = await api.systemConfigApi.getConfig();
|
||||||
|
await api.systemConfigApi.updateConfig({
|
||||||
|
systemConfigDto: { ...current, machineLearning: config.machineLearning },
|
||||||
|
});
|
||||||
|
await refreshConfig();
|
||||||
|
notificationController.show({ message: 'Settings saved', type: NotificationType.Info });
|
||||||
|
} catch (error) {
|
||||||
|
handleError(error, 'Unable to save settings');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function resetToDefault() {
|
||||||
|
await refreshConfig();
|
||||||
|
const { data: defaults } = await api.systemConfigApi.getDefaults();
|
||||||
|
config = defaults;
|
||||||
|
|
||||||
|
notificationController.show({ message: 'Reset settings to defaults', type: NotificationType.Info });
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<div class="mt-2">
|
||||||
|
{#await refreshConfig() then}
|
||||||
|
<div in:fade={{ duration: 500 }}>
|
||||||
|
<form autocomplete="off" on:submit|preventDefault class="mx-4 flex flex-col gap-4 py-4">
|
||||||
|
<SettingSwitch
|
||||||
|
title="Enabled"
|
||||||
|
subtitle="Use machine learning features"
|
||||||
|
bind:checked={config.machineLearning.enabled}
|
||||||
|
/>
|
||||||
|
|
||||||
|
<hr />
|
||||||
|
|
||||||
|
<SettingInputField
|
||||||
|
inputType={SettingInputFieldType.TEXT}
|
||||||
|
label="URL"
|
||||||
|
desc="URL of machine learning server"
|
||||||
|
bind:value={config.machineLearning.url}
|
||||||
|
required={true}
|
||||||
|
disabled={!config.machineLearning.enabled}
|
||||||
|
isEdited={!(config.machineLearning.url === config.machineLearning.url)}
|
||||||
|
/>
|
||||||
|
|
||||||
|
<SettingSwitch
|
||||||
|
title="SMART SEARCH"
|
||||||
|
subtitle="Extract CLIP embeddings for smart search"
|
||||||
|
bind:checked={config.machineLearning.clipEncodeEnabled}
|
||||||
|
disabled={!config.machineLearning.enabled}
|
||||||
|
/>
|
||||||
|
|
||||||
|
<SettingSwitch
|
||||||
|
title="FACIAL RECOGNITION"
|
||||||
|
subtitle="Recognize and group faces in photos"
|
||||||
|
disabled={!config.machineLearning.enabled}
|
||||||
|
bind:checked={config.machineLearning.facialRecognitionEnabled}
|
||||||
|
/>
|
||||||
|
|
||||||
|
<SettingSwitch
|
||||||
|
title="IMAGE TAGGING"
|
||||||
|
subtitle="Tag and classify images"
|
||||||
|
disabled={!config.machineLearning.enabled}
|
||||||
|
bind:checked={config.machineLearning.tagImageEnabled}
|
||||||
|
/>
|
||||||
|
|
||||||
|
<SettingButtonsRow
|
||||||
|
on:reset={reset}
|
||||||
|
on:save={saveSetting}
|
||||||
|
on:reset-to-default={resetToDefault}
|
||||||
|
showResetToDefault={!isEqual(config, defaultConfig)}
|
||||||
|
/>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
{/await}
|
||||||
|
</div>
|
||||||
Loading…
Reference in New Issue