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.

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

Client configuration #4

Merged
merged 23 commits into from
Jan 25, 2022
Merged

Client configuration #4

merged 23 commits into from
Jan 25, 2022

Conversation

Tparuchuri
Copy link
Collaborator

All SDK Contribution checklist:

This checklist is used to make sure that common guidelines for a pull request are followed.

  • Please open PR in Draft mode if it is:
    • Work in progress or not intended to be merged.
    • Encountering multiple pipeline failures and working on fixes.
  • If an SDK is being regenerated based on a new swagger spec, a link to the pull request containing these swagger spec changes has been included above.
  • I have read the contribution guidelines.
  • The pull request does not introduce breaking changes.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

SDK Generation Guidelines

  • The generate.cmd file for the SDK has been updated with the version of AutoRest, as well as the commitid of your swagger spec or link to the swagger spec, used to generate the code. (Track 2 only)
  • The *.csproj and AssemblyInfo.cs files have been updated with the new version of the SDK. Please double check nuget.org current release version.

Additional management plane SDK specific contribution checklist:

Note: Only applies to Microsoft.Azure.Management.[RP] or Azure.ResourceManager.[RP]

  • Include updated management metadata.
  • Update AzureRP.props to add/remove version info to maintain up to date API versions.

Management plane SDK Troubleshooting

  • If this is very first SDK for a services and you are adding new service folders directly under /SDK, please add new service label and/or contact assigned reviewer.

  • If the check fails at the Verify Code Generation step, please ensure:

    • Do not modify any code in generated folders.
    • Do not selectively include/remove generated files in the PR.
    • Do use generate.ps1/cmd to generate this PR instead of calling autorest directly.
      Please pay attention to the @microsoft.csharp version output after running generate.ps1. If it is lower than current released version (2.3.82), please run it again as it should pull down the latest version.

    Note: We have recently updated the PSH module called by generate.ps1 to emit additional data. This would help reduce/eliminate the Code Verification check error. Please run following command:

      `dotnet msbuild eng/mgmt.proj /t:Util /p:UtilityName=InstallPsModules`
    

Old outstanding PR cleanup

Please note:
If PRs (including draft) has been out for more than 60 days and there are no responses from our query or followups, they will be closed to maintain a concise list for our reviewers.

@@ -151,6 +156,8 @@ public virtual async Task<Response<PersonalizerRankResult>> RankAsync(Personaliz
}
else
{
Models.PersonalizerClientProperties result = await ClientConfigurationRestClient.PostAsync(cancellationToken).ConfigureAwait(false);
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Calling the ClientConfigurationClient here instead when isLocalInference is true (these two lines will be moved) just to test the new code is working when RankTest is called. But few things have to be modified while testing for the test case to work. Tested in my local machine and it worked as below.
Standard Output: 
InternalId: 86aa7660871843dca1c703400557b71c
StorageBlobUri: BlobURI
LearningMode: 0
Exploration Percentage: 1
initialCommandline: --cb_explore_adf --json --quiet --epsilon 0.0 --first_only --id N/A

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The point of the thick client, is decrease latency. By making a configuration network request on every rank call, the latency is effectively increased. This configuration should also be shared across the entire client, not just the rank call. Consider moving to a wider scope and changing the client configuration to a TTL lazy initialization.

@Tparuchuri Tparuchuri changed the base branch from main to thickClentFeature January 13, 2022 23:03
@@ -151,6 +156,8 @@ public virtual async Task<Response<PersonalizerRankResult>> RankAsync(Personaliz
}
else
{
Models.PersonalizerClientProperties result = await ClientConfigurationRestClient.PostAsync(cancellationToken).ConfigureAwait(false);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The point of the thick client, is decrease latency. By making a configuration network request on every rank call, the latency is effectively increased. This configuration should also be shared across the entire client, not just the rank call. Consider moving to a wider scope and changing the client configuration to a TTL lazy initialization.

@@ -182,6 +189,8 @@ public virtual async Task<Response<PersonalizerRankResult>> RankAsync(Personaliz
/// <param name="cancellationToken"> The cancellation token to use. </param>
public virtual async Task<Response<PersonalizerRankResult>> RankAsync(IEnumerable<PersonalizerRankableAction> actions, IEnumerable<object> contextFeatures, CancellationToken cancellationToken = default)
{
Models.PersonalizerClientProperties result = await ClientConfigurationRestClient.PostAsync(cancellationToken).ConfigureAwait(false);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As mentioned in the previous comment, this is duplicated logic.

@@ -182,6 +189,8 @@ public virtual async Task<Response<PersonalizerRankResult>> RankAsync(Personaliz
/// <param name="cancellationToken"> The cancellation token to use. </param>
public virtual async Task<Response<PersonalizerRankResult>> RankAsync(IEnumerable<PersonalizerRankableAction> actions, IEnumerable<object> contextFeatures, CancellationToken cancellationToken = default)
{
Models.PersonalizerClientProperties result = await ClientConfigurationRestClient.PostAsync(cancellationToken).ConfigureAwait(false);
Console.WriteLine("InternalId: " + result.ApplicationID + "\nStorageBlobUri: " + result.ModelBlobUri + "\nLearningMode: " + result.ProtocolVersion + "\nExploration Percentage: " + result.InitialExplorationEpsilon + "\ninitialCommandline: " + result.InitialCommandLine);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do not write to console in production code. If something needs to be output, it should be done through a logger. For this particular case, I would suggest removing entirely.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TIP: When you want to print the entire object is usually best to use JSON serialization. Console.Write(JsonConvert.SerializeObject(result));

config["appid"] = result.Value.ApplicationID;

// set up the model
config["model.source"] = result.Value.ModelBlobUri;
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be "model.blob.uri"


// set up the model
config["model.source"] = result.Value.ModelBlobUri;
config["model.vw.initial_command_line"] = result.Value.InitialCommandLine;
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be "vw.commandline"


namespace Azure.AI.Personalizer.Models
{
internal class ClientConfigurationRestClient
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why isn't this class in the generated folder? Rest clients should not be hand written, only extended.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As client Post is not part of swagger because of which it's not part of generated. So implemented it outside generated to get client config details

/// <summary> Gets the configuration details for the live model to use </summary>
internal Configuration GetClientConfigurationForLiveModel()
{
result = new Lazy<Models.PersonalizerClientProperties>(() => ClientConfigurationRestClient.Post());
Copy link
Collaborator

@tyclintw tyclintw Jan 14, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should have a TTL in case the configuration on the server is updated.

Also, I would suggest the Lazy TTL be managed by the caller, not inside this method. In other words, the caller should use Lazy.

result = new Lazy<Models.PersonalizerClientProperties>(() => ClientConfigurationRestClient.Post());
Configuration config = new Configuration();
// configure the personalizer loop
config["appid"] = result.Value.ApplicationID;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of call result.Value half a dozen times, please use a temporary reference.

{
internal partial class PersonalizerClientProperties
{
internal static PersonalizerClientProperties DeserializePersonalizerServiceProperties(JsonElement element)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you explain why we need a custom deserializer instead of using JsonSerializer.Deserialize<PersonalizerClientProperties>(string)?

@Tparuchuri Tparuchuri merged commit 355227d into thickClentFeature Jan 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants