Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update method names for Export/Import models as per suggestions. #23

Merged
merged 2 commits into from
Feb 28, 2022
Merged

Update method names for Export/Import models as per suggestions. #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4a92713
Update method names for Export/Import models as per suggestions.
Feb 28, 2022
d7ae82d
Updates after running codecheck.ps1 script
Feb 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions sdk/personalizer/Azure.AI.Personalizer/api/Azure.AI.Personalizer.netstandard2.0.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,14 @@ public PersonalizerAdministrationClient(System.Uri endpoint, Azure.Core.TokenCre
public virtual System.Threading.Tasks.Task<Azure.Response> DeletePersonalizerEvaluationAsync(string evaluationId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual Azure.Response DeletePersonalizerLogs(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual System.Threading.Tasks.Task<Azure.Response> DeletePersonalizerLogsAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual Azure.Response<System.IO.Stream> ExportPersonalizerSignedModel(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual System.Threading.Tasks.Task<Azure.Response<System.IO.Stream>> ExportPersonalizerSignedModelAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual Azure.Response<System.IO.Stream> ExportPersonalizerModel(bool isSigned, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual System.Threading.Tasks.Task<Azure.Response<System.IO.Stream>> ExportPersonalizerModelAsync(bool isSigned, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual Azure.Response<Azure.AI.Personalizer.PersonalizerEvaluation> GetPersonalizerEvaluation(string evaluationId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Personalizer.PersonalizerEvaluation>> GetPersonalizerEvaluationAsync(string evaluationId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual Azure.Pageable<Azure.AI.Personalizer.PersonalizerEvaluation> GetPersonalizerEvaluations(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual Azure.AsyncPageable<Azure.AI.Personalizer.PersonalizerEvaluation> GetPersonalizerEvaluationsAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual Azure.Response<Azure.AI.Personalizer.PersonalizerLogProperties> GetPersonalizerLogProperties(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Personalizer.PersonalizerLogProperties>> GetPersonalizerLogPropertiesAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual Azure.Response<System.IO.Stream> GetPersonalizerModel(bool isSigned = false, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual System.Threading.Tasks.Task<Azure.Response<System.IO.Stream>> GetPersonalizerModelAsync(bool isSigned = false, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual Azure.Response<Azure.AI.Personalizer.PersonalizerModelProperties> GetPersonalizerModelProperties(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Personalizer.PersonalizerModelProperties>> GetPersonalizerModelPropertiesAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual Azure.Response<Azure.AI.Personalizer.PersonalizerPolicy> GetPersonalizerPolicy(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
Expand Down
50 changes: 9 additions & 41 deletions sdk/personalizer/Azure.AI.Personalizer/src/Models/PersonalizerAdministrationClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,12 +270,13 @@ public virtual Response ApplyPersonalizerEvaluation(PersonalizerPolicyReferenceO
}
}

/// <summary> Get the model file generated by Personalizer service. </summary>
/// <param name="isSigned">True if requesting digitally signed model zip archive, false otherwise.</param>
/// <summary> Export the current model used by Personalizer service. </summary>
/// <param name="isSigned">True if requesting signed model zip archive, false otherwise.</param>
/// <param name="cancellationToken"> The cancellation token to use. </param>
public virtual async Task<Response<Stream>> GetPersonalizerModelAsync(bool isSigned = false, CancellationToken cancellationToken = default)
/// <remarks> Exports the Personalizer model. </remarks>
public virtual async Task<Response<Stream>> ExportPersonalizerModelAsync(bool isSigned, CancellationToken cancellationToken = default)
{
using var scope = _clientDiagnostics.CreateScope("PersonalizerAdministrationClient.GetPersonalizerModel");
using var scope = _clientDiagnostics.CreateScope("PersonalizerAdministrationClient.ExportPersonalizerModel");
scope.Start();
try
{
Expand All @@ -288,12 +289,13 @@ public virtual async Task<Response<Stream>> GetPersonalizerModelAsync(bool isSig
}
}

/// <summary> Get the model file generated by Personalizer service. </summary>
/// <summary> Export the current model used by Personalizer service. </summary>
/// <param name="isSigned">True if requesting signed model zip archive, false otherwise.</param>
/// <param name="cancellationToken"> The cancellation token to use. </param>
public virtual Response<Stream> GetPersonalizerModel(bool isSigned = false, CancellationToken cancellationToken = default)
/// <remarks> Exports the Personalizer model. </remarks>
public virtual Response<Stream> ExportPersonalizerModel(bool isSigned, CancellationToken cancellationToken = default)
{
using var scope = _clientDiagnostics.CreateScope("PersonalizerAdministrationClient.GetPersonalizerModel");
using var scope = _clientDiagnostics.CreateScope("PersonalizerAdministrationClient.ExportPersonalizerModel");
scope.Start();
try
{
Expand All @@ -306,40 +308,6 @@ public virtual Response<Stream> GetPersonalizerModel(bool isSigned = false, Canc
}
}

/// <summary> Export the current model used by Personalizer service. </summary>
/// <param name="cancellationToken"> The cancellation token to use. </param>
/// <remarks> Gets the signed Personalizer model. </remarks>
public virtual async Task<Response<Stream>> ExportPersonalizerSignedModelAsync(CancellationToken cancellationToken = default)
{
using var scope = _clientDiagnostics.CreateScope("PersonalizerAdministrationClient.ExportPersonalizerSignedModel");
scope.Start();
try
{
return await GetPersonalizerModelAsync(true, cancellationToken).ConfigureAwait(false);
}
catch (Exception e)
{
scope.Failed(e);
throw;
}
}

/// <summary> Export the current model used by Personalizer service. </summary>
public virtual Response<Stream> ExportPersonalizerSignedModel(CancellationToken cancellationToken = default)
{
using var scope = _clientDiagnostics.CreateScope("PersonalizerAdministrationClient.ExportPersonalizerSignedModel");
scope.Start();
try
{
return GetPersonalizerModel(isSigned: true, cancellationToken);
}
catch (Exception e)
{
scope.Failed(e);
throw;
}
}

/// <summary> Replace the current model used by Personalizer service with an updated model. </summary>
/// <param name="modelBody">Stream representing the digitally signed model zip archive.</param>
/// <param name="cancellationToken"> The cancellation token to use. </param>
Expand Down
17 changes: 5 additions & 12 deletions sdk/personalizer/Azure.AI.Personalizer/tests/Personalizer/ModelTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,30 +17,23 @@ public ModelTests(bool isAsync) : base(isAsync)
public async Task ModelTest()
{
PersonalizerAdministrationClient client = GetAdministrationClient(isSingleSlot: true);
await GetModel(false, client);
await GetModel(true, client);
await ExportModel(false, client);
await ExportModel(true, client);
await GetModelProperties(client);
Response<Stream> response = await ExportSignedModel(client);
await ImportSignedModel(response.Value, client);
await ResetModel(client);
}

[Test]
public async Task ExportImportModelTest()
{
PersonalizerAdministrationClient client = GetAdministrationClient(isSingleSlot: true);
Response<Stream> response = await ExportSignedModel(client);
Response<Stream> response = await ExportModel(true, client);
await ImportSignedModel(response.Value, client);
}

private async Task<Response<Stream>> GetModel(bool signed, PersonalizerAdministrationClient client)
{
return await client.GetPersonalizerModelAsync(signed);
}

private async Task<Response<Stream>> ExportSignedModel(PersonalizerAdministrationClient client)
private async Task<Response<Stream>> ExportModel(bool isSigned, PersonalizerAdministrationClient client)
{
return await client.ExportPersonalizerSignedModelAsync();
return await client.ExportPersonalizerModelAsync(isSigned);
}

private async Task<Response> ImportSignedModel(Stream modelBody, PersonalizerAdministrationClient client)
Expand Down
Loading